docusaurus plugin auto sidebars

Installation

yarn add docusaurus-plugin-auto-sidebars

oder

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

Verwendung

1. Erstellen Sie eine leere sidebars.auto.js in der Wurzel des Projekts

2. Fügen Sie dieses Plugin dem plugins -Array in docusaurus.config.js hinzu:

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

Oder wenn Sie einen benutzerdefinierten docs -Ordner angeben möchten:

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

Wie ändere ich den Titel der Ordner?

Fügen Sie einfach eine sidebars.yaml in Ihren docs -Ordner hinzu:

- 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

Wie ändere ich die Reihenfolge der Dateien und Ordner?

Methode 1 : Durch Hinzufügen einer Nummer zum Betteln von Dateien und Ordnern eine Nummer hinzufügen

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

Hinweis: Sie können auch negative Zahlen verwenden, um sie in umgekehrter Reihenfolge anzuzeigen: -1. fileX.md

Methode 2 : Definieren Sie sie in der Datei 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