Navigation

ctrl alt doc builds navigation from the structure of your docs/ directory.

Directories become categories, while Markdown files become documentation pages.

Example structure #

docs/
├── index.md
├── getting-started/
│   ├── _category.yml
│   ├── index.md
│   └── installation.md
└── reference/
    ├── _category.yml
    ├── index.md
    └── kitchen-sink.md

Categories #

A directory represents a category.

An index.md inside that directory becomes the category's landing page.

Categories with an index.md page link to that landing page when you click their label in the sidebar. The disclosure control expands or collapses their child pages. Categories without an index.md page can still be expanded from the sidebar, but have no landing page to open.

For example:

docs/getting-started/index.md

becomes:

/getting-started

Pages #

Markdown files other than index.md become individual pages.

For example:

docs/getting-started/installation.md

becomes:

/getting-started/installation

Category configuration #

A category can have an _category.yml file.

This can be used to configure its label, position, collapsed state, badge, and visibility.

Example:

label: Getting Started
position: 1
collapsed: false
badge: New
hidden: false

The supported badge values are New, Updated, and Beta. A hidden category and all of its pages are omitted from navigation.

Sidebar configuration #

Individual pages can also control how they appear in the sidebar using frontmatter.

See Frontmatter for details.