This documentation is build using Documenter.jl and DocumenterVitepress.jl, hence a working installaion of VitePress in your system needs to be installed.

Prerequisites

• Node.js version 18 or higher.

VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with:

npm

$ npm add -D vitepress

pnpm

$ pnpm add -D vitepress

yarn

$ yarn add -D vitepress

bun

$ bun add -D vitepress

Building the Documentation

Building the documentations takes two steps:

include("gen_mds.jl")

which can generate markdonw files from .jl files and then

include("make.jl")

to generate .md files compatible with VitePress.

Start a local dev server

To see the documentation locally run:

You should have the following package.json which is requiered to build/preview the docs

{
  ...
  "scripts": {
    "docs:dev": "vitepress dev docs/docs",
    "docs:build": "vitepress build docs/docs",
    "docs:preview": "vitepress preview docs/docs"
  },
  ...
}

The docs:dev script will start a local dev server with instant hot updates. Run it with the following command:

npm

$ npm run docs:dev

pnpm

$ pnpm run docs:dev

yarn

$ yarn docs:dev

bun

$ bun run docs:dev

Instead of npm scripts, you can also invoke VitePress directly with:

npm

$ npx vitepress dev docs

pnpm

$ pnpm exec vitepress dev docs

bun

$ bunx vitepress dev docs

For more information see the Documentation from VitePress.