Hier anfangen

Die CLI installieren, einen Workspace anlegen und Ihr erstes Dokument im Browser öffnen.

Docxcelerate braucht Node.js 20 oder neuer und sonst nichts. Schreiben, Vorschau und das Packen von DOCX laufen alle lokal — es gibt kein Konto anzulegen und keinen Dienst zu erreichen, bevor Sie ein Dokument sehen.

Die CLI installieren

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

Das ist der ganze erste Durchlauf. Wenn Sie den Befehl lieber in Ihrem PATH hätten:

npm install -g docxcelerate
dxcl init my-documents

Oder fügen Sie ihn einem bestehenden Repository hinzu, wo npx dxcl ihn dann lokal auflöst:

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

Der Befehl lautet npx docxcelerate, nicht npx dxcl — npx löst den Paketnamen auf, und die Binary darin heißt dxcl.

Einen Workspace anlegen

dxcl init my-documents

dxcl init schreibt einen in sich geschlossenen Vite-Workspace und führt darin npm install aus. Ohne Argumente aufgerufen fragt der Befehl nach Name, Template und API-Endpoint, statt sie als Flags zu nehmen:

dxcl init

Flag	Was es tut
`--dir <parent-dir>`	Legt den Workspace in einem bestehenden Verzeichnis an
`--sample`	Legt ein funktionierendes Beispieldokument mit an (Standard)
`--blank`	Lässt `documents/` leer
`--api-endpoint <url>`	Richtet den Workspace auf eine Engine aus
`--no-api-endpoint`	Richtet ohne eine ein; Sie können sie später ergänzen

Der Endpoint wird nur für Dokumente mit generiertem Text gebraucht und lässt sich jederzeit nachtragen — siehe die Engine.

Was dabei herauskommt

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

Alles oberhalb von documents/ ist die Vorschau-App. documents/ ist Ihre Arbeit: ein Verzeichnis je Dokument — und mit --sample liegt welcome/ schon darin.

docxcelerate.config.json enthält benannte Presets für das Build- und Upload-Verhalten. Alles andere ist ein gewöhnliches Vite-Projekt — öffnen Sie es in Ihrem Editor, und es verhält sich auch so.

Die Vorschau öffnen

npm run dev

Die Vorschau-Site läuft auf 127.0.0.1:4507. Wählen Sie ein Dokument aus: es wird gegen seine Vorschaudaten aufgelöst, im Browser in eine echte .docx gepackt und mit docx-preview wieder eingelesen — was Sie ansehen, ist also die Datei selbst und keine Annäherung daran.

Bearbeiten Sie eine Datei unter documents/, und die Seite lädt mit der Änderung neu.

Drei weitere Skripte kommen mit dem Workspace:

Skript	Was es ausführt
`npm run document:new`	`dxcl document new` — ein neues Dokument
`npm run document:node`	`dxcl document node` — ein neuer Node darin
`npm run documents:check`	`tsc` über jedes Dokument

Wie es weitergeht

Nodes schreiben — die Bausteine, aus denen ein Dokument besteht
Dokumentprojekte — die Dateien eines Dokuments und was sie konfiguriert
Das Node-Modell — jeder Node-Typ, mit einer Vorschau zu jedem

Diese Seite auf GitHub bearbeiten ↗ Diese Seite als Markdown lesen