Sidebar

Creating a sidebar is useful to:

• Group multiple related documents into an ordered tree
• Display a common sidebar on each of those documents
• Provide paginated navigation, with next/previous button

To use sidebars on your Docusaurus site:

1. Define a sidebars file that exports a dictionary of sidebar objects.
2. Pass its path to the @docusaurus/plugin-docs plugin directly or via @docusaurus/preset-classic.

export default {  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          sidebarPath: './sidebars.js',        },      },    ],  ],};

This section serves as an overview of miscellaneous features of the doc sidebar. In the following sections, we will more systematically introduce the following concepts:

import DocCardList from '@theme/DocCardList';

<DocCardList />

If the sidebarPath is unspecified, Docusaurus automatically generates a sidebar for you, by using the filesystem structure of the docs folder:

export default {
  mySidebar: [
    {
      type: 'autogenerated',
      dirName: '.', // generate sidebar from the docs folder (or versioned_docs/<version>)
    },
  ],
};

You can also define your sidebars explicitly.

A sidebar is a hierarchy of categories, doc links, and other hyperlinks.

type Sidebar =
  // Normal syntax
  | SidebarItem[]
  // Shorthand syntax
  | {[categoryLabel: string]: SidebarItem[]};

For example:

export default {
  mySidebar: [
    {
      type: 'category',
      label: 'Getting Started',
      items: [
        {
          type: 'doc',
          id: 'doc1',
        },
      ],
    },
    {
      type: 'category',
      label: 'Docusaurus',
      items: [
        {
          type: 'doc',
          id: 'doc2',
        },
        {
          type: 'doc',
          id: 'doc3',
        },
      ],
    },
    {
      type: 'link',
      label: 'Learn more',
      href: 'https://example.com',
    },
  ],
};

This is a sidebars file that exports one sidebar, called mySidebar. It has three top-level items: two categories and one external link. Within each category, there are a few doc links.

A sidebars file can contain multiple sidebar objects, identified by their object keys.

type SidebarsFile = {
  [sidebarID: string]: Sidebar;
};

By enabling the themeConfig.docs.sidebar.hideable option, you can make the entire sidebar hideable, allowing users to better focus on the content. This is especially useful when content is consumed on medium-sized screens (e.g. tablets).

export default {  themeConfig: {    docs: {      sidebar: {        hideable: true,      },    },  },};

The themeConfig.docs.sidebar.autoCollapseCategories option would collapse all sibling categories when expanding one category. This saves the user from having too many categories open and helps them focus on the selected section.

export default {  themeConfig: {    docs: {      sidebar: {        autoCollapseCategories: true,      },    },  },};

To pass CSS classes to a sidebar item, add the optional className attribute to any of the items. This is useful to apply visual customizations to specific sidebar items.

{  type: 'doc',  id: 'doc1',  className: 'sidebar-item--highlighted',};

To pass in custom props to a sidebar item, add the optional customProps object to any of the items. This is useful to apply site customizations by swizzling React components rendering sidebar items.

{  type: 'doc',  id: 'doc1',  customProps: {    badges: ['new', 'green'],    featured: true,  },};

Passing a unique key attribute can help uniquely identify a sidebar item. Sometimes other attributes (such as label) are not enough to distinguish two sidebar items from each other.

{  type: 'category',  label: 'API', // You may have multiple categories with this widespread label  key: 'api-for-feature-1', // and now, they can be uniquely identified};

By default, breadcrumbs are rendered at the top, using the "sidebar path" of the current page.

This behavior can be disabled with plugin options:

export default {  presets: [    [      '@docusaurus/preset-classic',      {        docs: {          breadcrumbs: false,        },      },    ],  ],};

A real-world example from the Docusaurus site:

import CodeBlock from '@theme/CodeBlock';
import SidebarsSource from '@site/sidebars.ts' with {type: 'text'};

<CodeBlock language="js" title="sidebars.js">
  {SidebarsSource
    .split('\n')
    // remove comments
    .map((line) => !['//','/*','*'].some(commentPattern => line.trim().startsWith(commentPattern)) && line)
    .filter(Boolean)
    .join('\n')}
</CodeBlock>