@voraus/docusaurus-theme

Shared Docusaurus 3 theme for voraus documentation sites. It gives every site the same look and the same baseline configuration, and keeps each site's docusaurus.config.ts down to about fifteen lines. A site can be published anywhere static files can go, and support for vdoc, the voraus documentation portal, is built in.

Install

npm install @voraus/docusaurus-theme

Needs Node.js 22.12+, Docusaurus 3.10+ and React 19.

Usage

import { createConfig } from '@voraus/docusaurus-theme'

import pkg from './package.json'

export default createConfig({
  title: 'voraus.example',
  tagline: 'voraus Example Project',
  projectName: 'voraus-example',
  version: pkg.version,
  docs: { sidebarPath: './sidebars.ts' },
})

title and projectName are required. projectName must be your repository name, which is also the path your docs are published under.

Do not add the theme to themes yourself. createConfig() does it, in the position that lets it wrap Docusaurus' own components instead of replacing them.

The build also writes objects.inv, a Sphinx inventory of every listed page, its headings and its figures, so that other sites can link here by name through intersphinx. A site on the hash router (future.experimental_router: 'hash') gets none, because its pages have no URLs of their own.

License

MIT