Documentation
How to add documentation for your product.
Goal
- Add documentation pages and categories using Velite.
How docs work
- Docs are generated by Velite from
content/docs. - Categories are folders with an
index.mdfile (frontmatter only). - Pages are
.mdor.mdxfiles with frontmatter.
Add a new doc page
- Create a new file under a category, for example:
workers/app/content/docs/guides/new-feature.md - Add frontmatter:
---
title: "New Feature"
description: "What it does and why it matters."
order: 3
---
- Write your content below the frontmatter.
Add a new category
- Create a folder, e.g.
workers/app/content/docs/platform/. - Add an
index.mdwith frontmatter only:
---
title: "Platform"
order: 4
---
- Add doc pages inside the folder.