Publish and export

VitePress build

The Build docs button runs the server-side configured command. The build prepares Markdown pages, normalizes media, copies uploads, then produces the folder:

./docs/.vitepress/dist

The build is intentionally explicit: Markdown editing does not restart VitePress on every keystroke.

ZIP export — recommended VitePress source project

The VitePress source project export is the priority choice. It produces an autonomous VitePress project archive.

It contains Markdown pages, uploads, the generated VitePress configuration and a minimal package.json to rebuild the documentation outside the NFZ application.

Expected structure:

.
├─ .github
│  └─ workflows
│     └─ deploy-vitepress-docs.yml
├─ docs
│  ├─ .vitepress
│  │  └─ config.js
│  ├─ api-examples.md
│  ├─ markdown-examples.md
│  └─ index.md
└─ package.json

Inside the exported project:

bun install
bun run docs:dev
bun run docs:build
bun run docs:preview

GitHub Pages deployment with Node 24

The VitePress source project archive embeds a ready-to-use GitHub Actions workflow:

.github/workflows/deploy-vitepress-docs.yml

This workflow:

• uses Node.js 24 via actions/setup-node@v6;
• installs Bun 1.3.6 via oven-sh/setup-bun@v2;
• runs bun run docs:build;
• publishes docs/.vitepress/dist with GitHub Pages;
• keeps FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true to detect incompatible actions early.

GitHub Pages deployment for the application user guide

In the nfz-docs-notion-editor application repository, the root .github/workflows/deploy-vitepress-docs.yml workflow now publishes the public user guide, not the technical /docs documentation.

It watches:

user-guide/**
.github/workflows/deploy-vitepress-docs.yml
package.json
bun.lock
bun.lockb

It runs:

bun run guide:build

Then publishes:

user-guide/.vitepress/dist

The user-guide/.vitepress/config.ts file uses process.env.VITEPRESS_BASE || '/guide/', so local usage keeps /guide/ while GitHub Pages can automatically use /<repository-name>/ through the workflow VITEPRESS_BASE variable.

ZIP export — built static site

The built static site export archives docs/.vitepress/dist.

Use it to deliver a frozen version, publish on static hosting, or archive a validated release.