Documentation

This template features inline documentation using roxygen2 syntax. For setting up an online documentation page there is a VitePress template included in docs. It uses the Catppuccin theme.

Adjusting the Documentation

• Adjust the docs/.vitepress/config.mts file to your needs.
• Update the markdown files in docs/md/.
• The documentation is automatically built via GitHub Actions using this workflow, but you can see a live preview or build it locally by doing the following:
  • Install Node.js.
  • Install pnpm.
  • Navigate to the docs/ directory:

    cd docs

  • Install dependencies with pnpm:

    pnpm i

  • Show a live preview:

    pnpm docs:dev

  • Build the site locally:

    pnpm docs:build

Alternatives for Documentation

Quarto would be a possible and recommended alternative for building documentation pages. If you write an R package you might also want to consider pkgdown.