docusaurus-plugin-auto-sidebars
v1.0.7
Published
Auto sidebars plugin for Docusaurus
Downloads
1,067
Readme
Installation
yarn add docusaurus-plugin-auto-sidebars
or
npm install docusaurus-plugin-auto-sidebars --save
Usage
Create an empty
sidebars.auto.js
in the root of the projectAdd this plugin to the
plugins
array indocusaurus.config.js
:
module.exports = {
// ...
plugins: [
'docusaurus-plugin-auto-sidebars'
],
}
Or, if you want to specify a custom docs
folder:
module.exports = {
// ...
plugins: [
['docusaurus-plugin-auto-sidebars', {
path:'mydocs'
}]
],
}
How to change the title of the folders?
Just add a sidebars.yaml
in your docs
folder:
- 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
How to change the order of the files and the folders?
Method 1: By adding a number to the beggining of files and folders
1.fileX.md
2.fileY.md
3.fileX.md
Note : You can also use negative numbers to display them in reverse order : -1. fileX.md
Method 2: Define them in the sidebars.yaml
file
- 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