docusaurus plugin auto sidebars
1.0.0
yarn add docusaurus-plugin-auto-sidebars
または
npm install docusaurus-plugin-auto-sidebars --save
空のsidebars.auto.js
を作成します。auto.jsプロジェクトのルートに
このプラグインをdocusaurus.config.js
のplugins
アレイに追加します:
module . exports = {
// ...
plugins : [
'docusaurus-plugin-auto-sidebars'
] ,
}
または、カスタムdocs
フォルダーを指定する場合は次のとおりです。
module . exports = {
// ...
plugins : [
[ 'docusaurus-plugin-auto-sidebars' , {
docs : 'mydocs'
} ]
] ,
}
docs
フォルダーにsidebars.yaml
を追加するだけです。
- 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 :ファイルとフォルダーのstegginingに番号を追加することにより
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