Verbaria Documentation

User and administrator guide for the Verbaria translation platform, built with VitePress. Published to https://docs.verbaria.org.

Migrated from the legacy Zanata MkDocs site. Some pages may still reference Zanata while the content is modernised for Verbaria.

Prerequisites

• Node.js 20 or newer
• npm (ships with Node)

Install

npm ci

Preview (local dev server)

Starts a hot-reloading dev server (default http://localhost:5173):

npm run docs:dev

Build

Generates the static site into docs/.vitepress/dist:

npm run docs:build

Preview the production build

Serves the already-built dist output locally so you can check it before deploy:

npm run docs:build
npm run docs:preview

Project layout

docs/                       # markdown content (the VitePress site root)
  index.md                  # home page (hero)
  user-guide/               # translator, project, admin, system-admin guides
  client/                   # command-line client + Maven plugin
  release-notes.md
  public/                   # static assets served at the site root
    images/                 # screenshots referenced as /images/…
    favicon.ico
  .vitepress/
    config.ts               # site config: nav, sidebar, search, edit links
    theme/                  # brand theme override (green accent)
.github/workflows/deploy.yml  # GitHub Pages deploy on push to main

Editing content

• Pages are plain Markdown under docs/.
• Add a new page to the sidebar in docs/.vitepress/config.ts (sidebar()).
• Reference images with a root-absolute path, e.g. ![alt](/images/foo.png); the file lives at docs/public/images/foo.png.

Markdown gotchas (Vue compiler)

VitePress renders Markdown through Vue, so a few literal tokens need care:

• {{ … }} is treated as a Vue interpolation even inside `code`. To show it literally, wrap it in v-pre: <code v-pre>{{Group name}}</code>.
• <word> pseudo-tags in prose (e.g. the <config> element) are parsed as HTML. Wrap them in backticks so they render as code.

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which builds the site and publishes docs/.vitepress/dist to GitHub Pages. The custom domain is set via CNAME (docs.verbaria.org).

License

Same license as the Verbaria/Zanata platform: GNU Lesser General Public License v2.1 (COPYING.LESSER), which incorporates the GNU General Public License v2 (COPYING.GPL).