Customize the order of your project sidebar with a Table of Contents file. This file allows you to:
- Customize the order of files in the sidebar
- Override the title of a file in the sidebar
- Selectively expose files in the sidebar - this allows you to hide items by not including them in your Table of Contents file
Note Currently only file-level objects can be included in the Table of Contents file. While it is possible to customize the order and display of files themselves, it is not currently possible to customize the order or display of inter-file objects (such as endpoints, path elements, and embedded models).
For any questions, please contact support@stoplight.io.
To get started, create a toc.json file under the root of your project repository. The structure of this file looks like:
{
"items": [
{
"type": "divider",
"title": "User Guides"
},
{
"type": "item",
"title": "A Custom Article Title",
"uri": "/docs/readme.md"
},
{
"type": "divider",
"title": "API Documentation"
},
{
"type": "item",
"title": "Custom API Title",
"uri": "/reference/test.json"
}
]
}
With a top-level items array, where each element is an object with:
- a type, which can be one of:
- divider - A logical break in a section
- item - A sidebar entry, which can be a Markdown, OpenAPI, or JSON Schema file
- a title, which can be used to override the title on the file itself
- if type is item, then uri with the path to the item from the root of the repository
With the file above added to the project, the resulting documentation sidebar for the project will now match each item present in the same order.
The sample file above will result in a documentation sidebar similar to the following:
