Empieza aquí
Empieza aquí
Instala la CLI, crea un workspace y abre tu primer documento en el navegador.
Docxcelerate necesita Node.js 20 o superior y nada más. La escritura, la vista previa y el empaquetado de DOCX se ejecutan en local — no hay cuenta que crear ni servicio al que llegar antes de ver un documento.
Instala la CLI
npx docxcelerate init my-documents
cd my-documents
npm run devEsa es toda la primera ejecución. Si prefieres tener el comando en tu PATH:
npm install -g docxcelerate
dxcl init my-documentsO añádelo a un repositorio existente, donde npx dxcl lo resuelve en local:
npm install --save-dev docxcelerate
npx dxcl init my-documentsEl comando es npx docxcelerate, no npx dxcl — npx resuelve el nombre del
paquete, y el binario que hay dentro se llama dxcl.
Crea un workspace
dxcl init my-documentsdxcl init escribe un workspace de Vite autocontenido y ejecuta npm install
dentro. Llamado sin argumentos pregunta por el nombre, la plantilla y el endpoint
de la API en lugar de tomarlos como flags:
dxcl init| Flag | Qué hace |
|---|---|
--dir <parent-dir> | Crea el workspace dentro de un directorio existente |
--sample | Incluye un documento de ejemplo funcional (por defecto) |
--blank | Deja documents/ vacío |
--api-endpoint <url> | Apunta el workspace a un motor de generación |
--no-api-endpoint | Lo configura sin uno; puedes añadirlo más tarde |
El endpoint solo hace falta para documentos con prosa generada, y se puede rellenar en cualquier momento — mira el motor.
Qué obtienes
my-documents/
docxcelerate.config.json
index.html
package.json
tsconfig.json
vite.config.ts
.gitignore
preview/
main.ts
styles.css
documents/
welcome/Todo lo que hay por encima de documents/ es la app de vista previa.
documents/ es tu trabajo: un directorio por documento, y con --sample empieza
con welcome/ ya dentro.
docxcelerate.config.json guarda presets con nombre para el comportamiento de
compilación y subida. Todo lo demás es un proyecto de Vite corriente — ábrelo en
tu editor y se comportará como tal.
Abre la vista previa
npm run devEl sitio de vista previa levanta en 127.0.0.1:4507. Elige un documento y se
resuelve contra sus datos de vista previa, se empaqueta en un .docx real en el
navegador y se vuelve a leer con docx-preview — así que lo que estás mirando es
el archivo en sí, no una aproximación.
Edita cualquier archivo bajo documents/ y la página se recarga con el cambio
puesto.
El workspace trae tres scripts más:
| Script | Qué ejecuta |
|---|---|
npm run document:new | dxcl document new — un documento nuevo |
npm run document:node | dxcl document node — un nodo nuevo dentro de uno |
npm run documents:check | tsc sobre cada documento |
Por dónde seguir
- Escribir nodos — las piezas de las que se compone un documento
- Proyectos de documento — los archivos de un documento y qué los configura
- El modelo de nodos — cada tipo de nodo, con una vista previa de cada uno