Начните отсюда

Установите CLI, создайте workspace и откройте свой первый документ в браузере.

Docxcelerate нужен Node.js 20 или новее и больше ничего. Написание, предпросмотр и сборка DOCX выполняются локально — не нужно заводить аккаунт и не нужно достучаться до какой-либо службы, прежде чем вы увидите документ.

Установите CLI

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

Это весь первый запуск. Если вам удобнее иметь команду в PATH:

npm install -g docxcelerate
dxcl init my-documents

Или добавьте её в существующий репозиторий, где npx dxcl затем разрешится локально:

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

Команда — npx docxcelerate, а не npx dxcl: npx разрешает имя пакета, а бинарник внутри называется dxcl.

Создайте workspace

dxcl init my-documents

dxcl init записывает самодостаточный Vite-workspace и выполняет в нём npm install. Вызванная без аргументов, команда спросит имя, шаблон и API-эндпоинт вместо того, чтобы брать их из флагов:

dxcl init

Флаг	Что делает
`--dir <parent-dir>`	Создаёт workspace внутри существующего каталога
`--sample`	Кладёт рядом рабочий документ-пример (по умолчанию)
`--blank`	Оставляет `documents/` пустым
`--api-endpoint <url>`	Направляет workspace на движок генерации
`--no-api-endpoint`	Настраивает без него; добавить можно позже

Эндпоинт нужен только для документов с генерируемым текстом, и вписать его можно в любой момент — см. движок.

Что получается

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

Всё, что выше documents/, — приложение предпросмотра. documents/ — ваша работа: по каталогу на документ, и с --sample там уже лежит welcome/.

docxcelerate.config.json хранит именованные пресеты поведения сборки и загрузки. Всё остальное — обычный проект на Vite: откройте его в редакторе, и он будет вести себя именно так.

Откройте предпросмотр

npm run dev

Сайт предпросмотра поднимается на 127.0.0.1:4507. Выберите документ — он будет разрешён на своих данных предпросмотра, собран в настоящий .docx прямо в браузере и прочитан обратно через docx-preview, так что вы смотрите на сам файл, а не на его приближение.

Отредактируйте любой файл в documents/ — и страница перезагрузится с изменением на месте.

С workspace идут ещё три скрипта:

Скрипт	Что запускает
`npm run document:new`	`dxcl document new` — новый документ
`npm run document:node`	`dxcl document node` — новый узел в нём
`npm run documents:check`	`tsc` по каждому документу

Куда дальше

Как писать узлы — части, из которых собирается документ
Проекты документов — файлы документа и то, что их настраивает
Модель узлов — каждый тип узла и предпросмотр для каждого

Изменить эту страницу на GitHub ↗ Читать эту страницу в Markdown