ContributingDocs site
Files, URLs and the sidebar
The URL of a page follows the path of its file. A meta.json file gives the order in the sidebar.
content/docs/concepts/deploys/steps.mdx → /docs/concepts/deploys/steps
content/docs/concepts/deploys/index.mdx → /docs/concepts/deploysmeta.json — title, icon and pages
index.mdx — keeps the URL of the subject
steps.mdx — one idea
Pages
A page is an MDX file in content/docs/. The URL follows the path.
A subject with more than one idea is a folder. Its index.mdx keeps the URL of the subject.
The sidebar
Each folder has a meta.json file:
{
"title": "Deploys",
"icon": "CloudUpload",
"pages": ["steps", "triggers", "deploy-hooks"]
}| Key | Use |
|---|---|
title | The name of the folder in the sidebar |
icon | The icon of the folder |
pages | The pages, in order |
- A top-level folder is a section of the sidebar.
- If a page is not in
pages, the build makes it but the sidebar does not list it.