Create and manage project documentation using Speed Docs and MDX. Use when the user wants to create docs, write documentation, add doc pages, set up a docs site, scaffold documentation, or mentions Speed Docs, MDX documentation, or project docs.
Build project documentation sites using Speed Docs, a CLI tool that generates static documentation websites from MDX content. Based on Fumadocs (Next.js).
speed-docs CLI installed globally (npm install -g speed-docs)If the project doesn't have a docs directory yet:
speed-docs init --dir ./docs
This creates the content directory with the template structure.
The content directory must follow this layout:
docs/ # content root
├── config.json # site configuration
├── logo.png # optional logo
└── docs/ # all documentation pages
├── index.mdx # landing page
├── getting-started/
│ ├── meta.json # navigation config for this folder
│ └── installation.mdx
└── api/
├── meta.json
└── reference.mdx
{
"nav": {
"title": "My Documentation",
"image": "/logo.png"
}
}
The image field is optional. If set, prefix with /.
Place images and other files in the content root directory (e.g., docs/). Reference them with / prefix: /logo.png, /screenshot.png.
Every .mdx file needs frontmatter with at least a title:
---