Begin hier

Installeer de CLI, zet een workspace op en open je eerste document in de browser.

Docxcelerate heeft Node.js 20 of nieuwer nodig en verder niets. Schrijven, preview en het inpakken van DOCX draaien allemaal lokaal — er is geen account aan te maken en geen dienst te bereiken voordat je een document ziet.

Installeer de CLI

npx docxcelerate init my-documents
cd my-documents
npm run dev

Dat is de hele eerste run. Wil je het commando liever in je PATH:

npm install -g docxcelerate
dxcl init my-documents

Of voeg het toe aan een bestaande repository, waar npx dxcl het dan lokaal oplost:

npm install --save-dev docxcelerate
npx dxcl init my-documents

Het commando is npx docxcelerate, niet npx dxcl — npx lost de pakketnaam op, en de binary erin heet dxcl.

Zet een workspace op

dxcl init my-documents

dxcl init schrijft een op zichzelf staande Vite-workspace en draait er npm install in. Zonder argumenten aangeroepen vraagt het om de naam, het template en het API-endpoint in plaats van ze als vlaggen te nemen:

dxcl init

Vlag	Wat het doet
`--dir <parent-dir>`	Maakt de workspace in een bestaande map
`--sample`	Zet er een werkend voorbeelddocument bij (standaard)
`--blank`	Laat `documents/` leeg
`--api-endpoint <url>`	Richt de workspace op een generatie-engine
`--no-api-endpoint`	Zet op zonder er een; je kunt het later toevoegen

Het endpoint is alleen nodig voor documenten met gegenereerde tekst, en kan op elk moment worden ingevuld — zie de engine.

Wat je krijgt

my-documents/
  docxcelerate.config.json
  index.html
  package.json
  tsconfig.json
  vite.config.ts
  .gitignore
  preview/
    main.ts
    styles.css
  documents/
    welcome/

Alles boven documents/ is de preview-app. documents/ is jouw werk: één map per document, en met --sample staat welcome/ er al in.

docxcelerate.config.json bevat benoemde presets voor build- en uploadgedrag. Al het andere is een gewoon Vite-project — open het in je editor en het gedraagt zich er ook naar.

Open de preview

npm run dev

De previewsite komt op op 127.0.0.1:4507. Kies een document en het wordt opgelost tegen zijn previewdata, in de browser tot een echte .docx ingepakt en met docx-preview weer ingelezen — wat je bekijkt is dus het bestand zelf, geen benadering ervan.

Bewerk een bestand onder documents/ en de pagina herlaadt met de wijziging erin.

De workspace komt met nog drie scripts:

Script	Wat het draait
`npm run document:new`	`dxcl document new` — een nieuw document
`npm run document:node`	`dxcl document node` — een nieuwe node daarin
`npm run documents:check`	`tsc` over elk document

Hoe nu verder

Nodes schrijven — de onderdelen waaruit een document bestaat
Documentprojecten — de bestanden van een document, en wat ze configureert
Het nodemodel — elk nodetype, met van elk een preview

Deze pagina bewerken op GitHub ↗ Deze pagina als Markdown lezen