docusaurus plugin auto sidebars

Installation

yarn add docusaurus-plugin-auto-sidebars

ou

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

Usage

1. Créez une sidebars.auto.js à la racine du projet

2. Ajoutez ce plugin au tableau plugins dans docusaurus.config.js :

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

Ou, si vous souhaitez spécifier un dossier docs personnalisés:

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

Comment changer le titre des dossiers?

Ajoutez simplement une sidebars.yaml dans votre dossier 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

Comment modifier l'ordre des fichiers et des dossiers?

Méthode 1 : en ajoutant un nombre à la mendicité des fichiers et des dossiers

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

Remarque: Vous pouvez également utiliser des nombres négatifs pour les afficher dans l'ordre inverse: -1. fileX.md

Méthode 2 : Définissez-les dans le fichier 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