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 ในรากของโครงการ
เพิ่มปลั๊กอินนี้ลงในอาร์เรย์ 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
ไฟล์ 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