Skip to content

docs: extend sidebar configuration #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yeoldegrove merged 1 commit into from
Oct 20, 2026
Merged

docs: extend sidebar configuration #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/contributing/documentation/vitepress-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,10 +296,24 @@ The page title. Used in navigation, search results, and as the default heading.

A short summary of the page content. Used as the meta description for SEO and displayed by `<SectionIndex />` for child page listings.

### Sidebar Configuration

**`order`** (number, default: 999)

Controls sort order in the sidebar and section listings. Lower numbers appear first. Use this to create logical groupings (e.g., `0` for intro, `10` for basics, `100` for advanced).

See [`sortMenusByFrontmatterOrder`](https://vitepress-sidebar.cdget.com/guide/options#sortmenusbyfrontmatterorder) for details.

**`exclude`** (boolean, default: false)

Set `exclude: true` in a page's front-matter to hide it from the sidebar. The page is still built and accessible at its URL.

See [`excludeFilesByFrontmatterFieldName`](https://vitepress-sidebar.cdget.com/guide/options#excludefilesbyfrontmatterfieldname) for details.

:::info Additional Sidebar Options
Have a look at the official [Sidebar Options Documentation](https://vitepress-sidebar.cdget.com/guide/options) for all possible configuration options.
:::

### Aggregated Content Fields

For content aggregated from external repositories, these fields enable proper placement and "Edit on GitHub" links. For complete details on aggregation configuration, see [Documentation Aggregation Configuration Reference](configuration.md).
Expand Down
Loading