Skip to main content

Docusaurus Template

The Docusaurus template is a pre-configured, docs-only Docusaurus 3.9 site located at bootstrap/docusaurus/template/.

What's included

FeatureDetails
Docusaurus version3.9.2
ModeDocs only (blog disabled)
Mermaid diagramsEnabled via @docusaurus/theme-mermaid
Dark modeAuto-detects system preference
TypeScriptFully typed config and components

Structure

template/
├── docs/
│ └── intro.md # Placeholder introduction page
├── src/
│ ├── css/custom.css # Custom styles
│ └── pages/
│ └── index.tsx # Homepage with CTA → /docs/intro
├── static/img/ # Logo and favicons
├── docusaurus.config.ts # Main configuration
├── sidebars.ts # Auto-generated from filesystem
└── package.json

Customising after bootstrap

After running docubuilder.sh, open docs/docusaurus.config.ts and update:

const config: Config = {
title: 'Your Project Name', // ← site title
url: 'https://your-docs-url.com', // ← production URL
organizationName: 'neulabscom', // ← your GitHub org
projectName: 'your-repo', // ← your repo name
// ...
navbar: {
items: [
// Update the GitHub href:
{ href: 'https://github.com/neulabscom/your-repo', label: 'GitHub', position: 'right' },
],
},
};

Writing docs

Add markdown files to docs/docs/. The sidebar is auto-generated from the folder structure.

Use _category_.json files to control section labels and ordering:

{
"label": "My Section",
"position": 2
}

Mermaid example