Module that provides Markdown-based documentation pages with SSR/prerendering support.
- Category-based organization - Documentation organized by categories with nested pages
- SSR & Prerendering - Content is prerendered for instant loading
- Table of Contents - Auto-generated TOC with scroll tracking
- Syntax highlighting - Code blocks with highlight.js
- Client-side navigation - Fast navigation between pages via NuxtLink
- Prefetching - Background prefetch of documentation content
- Responsive design - Works on desktop and mobile
- Create
.mdfiles incontent/{category}/ - Register pages in
DOC_CATEGORIESconstant (atomic/bosons/constants/documentation.ts)
| Function | Description |
|---|---|
parseDocPath |
Parse URL path to category/slug |
parseMarkdown |
Convert markdown to HTML |
parseHeadings |
Extract headings from HTML |
loadDocContentServer |
Load content during SSR |
loadDocContentClient |
Load content on client |
useHeadings |
Scroll tracking for TOC |
useDocumentation |
Prefetch helpers |