From 11953805f6f185b6d2e0b932f73f841cc0508534 Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Tue, 20 Oct 2026 08:47:06 +0200 Subject: [PATCH] docs: extend sidebar configuration Signed-off-by: Eike Waldt On-behalf-of: SAP --- .../documentation/vitepress-features.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/contributing/documentation/vitepress-features.md b/docs/contributing/documentation/vitepress-features.md index c779fd0..f62d958 100644 --- a/docs/contributing/documentation/vitepress-features.md +++ b/docs/contributing/documentation/vitepress-features.md @@ -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 `` 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).