The docs feature provides users with a way to organize Markdown files in a hierarchical format.
Every document has a unique
id. By default, a document
id is the name of the document (without the extension) relative to the root docs directory.
greeting.md id is
guide/hello.md id is
However, the last part of the
id can be defined by user in the front matter. For example, if
guide/hello.md's content is defined as below, its final
If you want more control over the last part of the document URL, it is possible to add a
slug (defaults to the
Home page docs
homePageId property, you can create a home page of your docs. To do this, you can create a new document, especially for this purpose with the id as
_index, or you could specify an existing document id.
Given the example above, now when you navigate to the path
/docs you will see that the document content with id is
getting-started. This functionality also works for docs with versioning enabled. Importantly, with document serves as home docs page, it will not be available at its URL. Following the example above, this means that the
docs/getting-started URL will be lead to a 404 error.
The document id of
_index is reserved exclusively for the home doc page, so it will not work as a standalone route. If left to the default, the page will not show a sidebar. If you wish to have a sidebar for this page, specify the document id that is listed in the sidebar file.
docs that you created (eg.
src/pages/docs.js) will take precedence over the route generated via the
To generate a sidebar to your Docusaurus site, you need to define a file that exports a sidebar object and pass that into the
@docusaurus/plugin-docs plugin directly or via
A sidebar object is defined like this:
Below is an example of a sidebar object. The key
docs is the id of the sidebar (can be renamed to something else) and
Getting Started is a category within the sidebar.
doc1 are both sidebar item.
Keep in mind that EcmaScript does not guarantee
You can also have multiple sidebars for different Markdown files by adding more top-level keys to the exported object.
As the name implies,
SidebarItem is an item defined in a Sidebar. There are a few types we support:
Sidebar item type that links to a doc page. Example:
Using just the Document ID is perfectly valid as well, the following is equivalent to the above:
Note that using this type will bind the linked doc to current sidebar, this means that if you access
doc1 page, the sidebar displayed will be the sidebar this item is on. For below case,
doc1 is bounded to
Sidebar item type that links to a non-document page. Example:
Sidebar item type that links to doc without bounding it to the sidebar. Example:
This is used to add hierarchies to the sidebar:
As an example, here's how we created the subcategory for "Docs" under "Guides" in this site:
Note: it's possible to use the shorthand syntax to create nested categories:
For sites with a sizable amount of content, we support the option to expand/collapse a category to toggle the display of its contents. Categories are collapsible by default. If you want them to be always expanded, set
Expanded categories by default
For docs that have collapsible categories, you may want more fine-grain control over certain categories. If you want specific categories to be always expanded, you can set
If you only want the documentation feature, you can run your Docusaurus 2 site without a landing page and display your documentation page as the index page instead.
To enable docs-only mode, set the
routeBasePath property of the
docs object to the root of your site. Also, set the
homePageId property to the ID of the document that you wish to show by default.
More details on functionality of home page for docs can be found in appropriate section.
Now, when visiting your site, it will show your initial document instead of a landing page.
You should delete the existing homepage at
./src/pages/index.js, or else there will be two files mapping to the same route!
There's also a "blog-only mode" for those who only want to use the blog feature of Docusaurus 2. You can use the same method detailed above. Follow the setup instructions on Blog-only mode.