Template Reference

Files

Template File	Purpose	Customise
docs/.vitepress/config.mts	VitePress config with auto-sidebar, Mermaid, search	Change SITE_TITLE, SITE_DESCRIPTION, GITHUB_URL
docs/index.md	Home page with hero + feature cards	Change project name, tagline, features
docs/getting-started.md	Setup instructions with Mermaid demo	Replace with project-specific content
docs/adr/000-template.md	ADR template	Copy to 001-your-decision.md
.github/workflows/deploy-docs.yml	Cloudflare Pages deploy	Change --project-name

Config Features

Auto-Discovered Sidebar

The config uses readdirSync to scan docs/ recursively. Any .md file (except index.md) appears in the sidebar automatically. Subdirectories become collapsible groups.

docs/
├── getting-started.md    → "Getting Started"
├── architecture.md       → "Architecture"
└── adr/
    ├── 000-template.md   → "000 Template"
    └── 001-use-redis.md  → "001 Use Redis"

File names are converted: kebab-case and SCREAMING_SNAKE → Title Case.

Mermaid Diagrams

Fenced code blocks with mermaid language render as diagrams:

```mermaid
graph TD
    A --> B --> C
```

Supported: flowcharts, sequence diagrams, ER diagrams, Gantt charts, pie charts, class diagrams.

ADR Format

# NNN. Title

**Status:** Accepted | Deprecated | Superseded by [NNN]

**Date:** YYYY-MM-DD

## Context
What motivates this decision?

## Decision
What are we doing?

## Alternatives Considered
| Alternative | Pros | Cons | Why rejected |

## Consequences
### Positive
### Negative
### Neutral