mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-25 12:38:57 +02:00
docs(v2): subcategories (#1670)
* docs(v2): subcategories * fix a typo and move call for pr to a comment till new side bar is implemented
This commit is contained in:
parent
96d6369985
commit
40cf5dcc56
1 changed files with 32 additions and 5 deletions
|
@ -33,13 +33,40 @@ The `docs` key in the exported object is just the name of that particular sideba
|
||||||
|
|
||||||
## Subcategories
|
## Subcategories
|
||||||
|
|
||||||
_This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._
|
To include subcategories in docs sidebar, use an object of the following shape
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: string, // sidebar label
|
||||||
|
items: string[], // strings of doc ids
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
in place of a string of id. As an example, here's how we created the subcategory for "Docs" under "Guides" in this site:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// sidebars.js
|
||||||
|
module.exports = {
|
||||||
|
docs: {
|
||||||
|
Guides: [
|
||||||
|
'creating-pages',
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Docs',
|
||||||
|
items: ['markdown-features', 'sidebar'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: Only one layer of nestedness is allowed.
|
||||||
|
|
||||||
|
**Note**: We're implementing a new sidebar!
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
||||||
Note: We're implementing a new sidebar, this following links to the legacy sidebar as a reference
|
_This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._
|
||||||
[source code](packages/docusaurus-theme-classic/src/theme/DocLegacySidebar/index.js)
|
|
||||||
|
|
||||||
If you are interested in this section, please follow up on our progress
|
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue