mirror of
https://github.com/vatesfr/xen-orchestra.git
synced 2026-09-10 22:14:48 -05:00
f99d7ab761
We now generate the sidebar automatically (based on the documentation folder structure and _category.json files), instead of declaring the doc structure manually in sidebars.ts. Simpler management This makes the sidebar easier to understand and maintain. It is now managed the exact same way as the sidebars for the Vates VMS and XCP-ng documentations. Clickable breadcrumbs The autogenerated sidebar also creates category index pages, which makes breadcrumb categories clickable, as they already are in the Vates VMS and XCP-ng documentations. Preview Capture d'écran 2026-09-08 094848 Unlisted pages Pages that should remain accessible but be hidden from the sidebar are now hidden using the unlisted: true metadata, instead of simply being omitted from sidebars.ts. Internal links and redirection Finally, the PR updates internal links and redirects to reflect the new folder structure and URLs.
33 lines
765 B
TypeScript
33 lines
765 B
TypeScript
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'
|
|
|
|
/**
|
|
* Creating a sidebar enables you to:
|
|
- create an ordered group of docs
|
|
- render a sidebar for each doc of that group
|
|
- provide next/previous navigation
|
|
|
|
The sidebars can be generated from the filesystem, or explicitly defined here.
|
|
|
|
Create as many sidebars as you want.
|
|
*/
|
|
|
|
|
|
const sidebars = {
|
|
// By default, Docusaurus generates a sidebar from the docs folder structure
|
|
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
|
|
|
|
// But you can create a sidebar manually
|
|
/*
|
|
tutorialSidebar: [
|
|
'intro',
|
|
'hello',
|
|
{
|
|
type: 'category',
|
|
label: 'Tutorial',
|
|
items: ['tutorial-basics/create-a-document'],
|
|
},
|
|
],
|
|
*/
|
|
};
|
|
|
|
module.exports = sidebars; |