docusaurus plugin auto sidebars

Установка

yarn add docusaurus-plugin-auto-sidebars

или

npm install docusaurus-plugin-auto-sidebars --save

Использование

1. Создайте пустые sidebars.auto.js в корне проекта

2. Добавьте этот плагин в массив plugins в docusaurus.config.js :

 module . exports = {
  // ...
  plugins : [
    'docusaurus-plugin-auto-sidebars'
  ] ,
}

Или, если вы хотите указать пользовательскую папку docs :

 module . exports = {
  // ...
  plugins : [
    [ 'docusaurus-plugin-auto-sidebars' , {
      docs : 'mydocs'
    } ]
  ] ,
} 

Как изменить заголовок папок?

Просто добавьте sidebars.yaml docs

- folder1 : 
  - Parent Folder One # First element is the title of parent, next elements are sub directories
  - subfolder1 : Sub Folder One
  - subfolder2 : Sub Folder Two
  - subfolder3 : false # Hide it!
  
- folder2 : 
  - Parent Folder Two # First element is the title
  - subfolder1 : Sub Folder One
  - subfolder2 : Sub Folder Two

Как изменить порядок файлов и папок?

Метод 1 : добавив номер в начало файлов и папок

1.fileX.md
2.fileY.md
3.fileX.md

Примечание. Вы также можете использовать отрицательные числа для отображения их в обратном порядке: -1. fileX.md

Метод 2 : Определите их на sidebars.yaml .

- folder1 : 
  - Parent Folder One : 1 # the order number beside the title
  - subfolder1 : Sub Folder One
  - subfolder2 : Sub Folder Two
  
- folder2 : 
  - Parent Folder Two : 2 # the order number beside the title
  - subfolder1 : Sub Folder One
  - subfolder2 : Sub Folder Two