@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. Support for vdoc, the voraus documentation portal (which frames each site inside its own header and version picker) is built in.
Start here
- Getting started: install it and get a site running
- Writing content: admonitions, diagrams, code, links
- Configuration: every option
createConfig()takes - Deployment: publish to vdoc or GitHub Pages
Then, as you need them:
| Page | What it covers |
|---|---|
| Features | What the theme changes, one page per feature |
| Customizing | Your own CSS, navbar items, replacing a part |
| Inside vdoc | What changes while vdoc frames your site |
| Troubleshooting | Error messages and what they mean |
| Developing this repository | Only if you are changing the theme itself |