Version: 2.0.0-beta.10

Theme configuration

This configuration applies to all main themes.

Common

Color mode

The classic theme provides by default light and dark mode support, with a navbar switch for the user.

It is possible to customize the color mode support within the colorMode object.

Accepted fields:

Name	Type	Default	Description
`defaultMode`	`'light' \| 'dark'`	`'light'`	The color mode when user first visits the site.
`disableSwitch`	`boolean`	`false`	Hides the switch in the navbar. Useful if you want to support a single color mode.
`respectPrefersColorScheme`	`boolean`	`false`	Whether to use the `prefers-color-scheme` media-query, using user system preferences, instead of the hardcoded `defaultMode`.
`switchConfig`	See below	See below	Dark/light switch icon options.
`switchConfig.darkIcon`	`string`	`'🌜'`	Icon for the switch while in dark mode.
`switchConfig.darkIconStyle`	JSX style object (see documentation)	`{}`	CSS to apply to dark icon.
`switchConfig.lightIcon`	`string`	`'🌞'`	Icon for the switch while in light mode.
`switchConfig.lightIconStyle`	JSX style object	`{}`	CSS to apply to light icon.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    colorMode: {
      defaultMode: 'light',
      disableSwitch: false,
      respectPrefersColorScheme: false,
      switchConfig: {
        darkIcon: '🌙',
        darkIconStyle: {
          marginLeft: '2px',
        },
        // Unicode icons such as '\u2600' will work
        // Unicode with 5 chars require brackets: '\u{1F602}'
        lightIcon: '\u{1F602}',
        lightIconStyle: {
          marginLeft: '1px',
        },
      },
    },
  },
};

caution

With respectPrefersColorScheme: true, the defaultMode is overridden by user system preferences.

If you only want to support one color mode, you likely want to ignore user system preferences.

Meta image

You can configure a default image that will be used for your meta tag, in particular og:image and twitter:image.

Accepted fields:

Name	Type	Default	Description
`image`	`string`	`undefined`	The meta image URL for the site. Relative to your site's "static" directory. Cannot be SVGs. Can be external URLs too.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    image: 'img/docusaurus.png',
  },
};

Metadata

You can configure additional html metadata (and override existing ones).

Accepted fields:

Name	Type	Default	Description
`metadata`	`Metadata[]`	`[]`	Any field will be directly passed to the `<meta />` tag. Possible fields include `id`, `name`, `property`, `content`, `itemprop`, etc.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    metadata: [{name: 'twitter:card', content: 'summary'}],
  },
};

Announcement bar

Sometimes you want to announce something in your website. Just for such a case, you can add an announcement bar. This is a non-fixed and optionally dismissable panel above the navbar. All configuration are in the announcementBar object.

Accepted fields:

Name	Type	Default	Description
`id`	`string`	`'announcement-bar'`	Any value that will identify this message.
`content`	`string`	`''`	The text content of the announcement. HTML will be interpolated.
`backgroundColor`	`string`	`'#fff'`	Background color of the entire bar.
`textColor`	`string`	`'#000'`	Announcement text color.
`isCloseable`	`boolean`	`true`	Whether this announcement can be dismissed with a '×' button.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    announcementBar: {
      id: 'support_us',
      content:
        'We are looking to revamp our docs, please fill <a target="_blank" rel="noopener noreferrer" href="#">this survey</a>',
      backgroundColor: '#fafbfc',
      textColor: '#091E42',
      isCloseable: false,
    },
  },
};

Accepted fields:

Name	Type	Default	Description
`title`	`string`	`undefined`	Title for the navbar.
`logo`	See below	`undefined`	Customization of the logo object.
`items`	`NavbarItem[]`	`[]`	A list of navbar items. See specification below.
`hideOnScroll`	`boolean`	`false`	Whether the navbar is hidden when the user scrolls down.
`style`	`'primary' \| 'dark'`	Same as theme	Sets the navbar style, ignoring the dark/light theme.

The logo can be placed in static folder. Logo URL is set to base URL of your site by default. Although you can specify your own URL for the logo, if it is an external link, it will open in a new tab. In addition, you can override a value for the target attribute of logo link, it can come in handy if you are hosting docs website in a subdirectory of your main website, and in which case you probably do not need a link in the logo to the main website will open in a new tab.

To improve dark mode support, you can also set a different logo for this mode.

Accepted fields:

Name	Type	Default	Description
`alt`	`string`	`undefined`	Alt tag for the logo image.
`src`	`string`	Required	URL to the logo image. Base URL is appended by default.
`srcDark`	`string`	`logo.src`	An alternative image URL to use in dark mode.
`href`	`string`	`siteConfig.baseUrl`	Link to navigate to when the logo is clicked.
`width`	`string \| number`	`undefined`	Specifies the `width` attribute.
`height`	`string \| number`	`undefined`	Specifies the `height` attribute.
`target`	`string`	Calculated based on `href` (external links will open in a new tab, all others in the current one).	The `target` attribute of the link; controls whether the link is opened in a new tab, the current one, or otherwise.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      title: 'Site Title',
      logo: {
        alt: 'Site Logo',
        src: 'img/logo.svg',
        srcDark: 'img/logo_dark.svg',
        href: 'https://docusaurus.io/',
        target: '_self',
        width: 32,
        height: 32,
      },
    },
  },
};

You can add items to the navbar via themeConfig.navbar.items.

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'doc',
          position: 'left',
          docId: 'introduction',
          label: 'Docs',
        },
        {to: 'blog', label: 'Blog', position: 'left'},
        {
          type: 'docsVersionDropdown',
          position: 'right',
        },
        {
          type: 'localeDropdown',
          position: 'right',
        },
        {
          href: 'https://github.com/facebook/docusaurus',
          position: 'right',
          className: 'header-github-link',
          'aria-label': 'GitHub repository',
        },
      ],
    },
  },
};

The items can have different behaviors based on the type field. The sections below will introduce you to all the types of navbar items available.

By default, Navbar items are regular links (internal or external).

React Router should automatically apply active link styling to links, but you can use activeBasePath in edge cases. For cases in which a link should be active on several different paths (such as when you have multiple doc folders under the same sidebar), you can use activeBaseRegex. activeBaseRegex is a more flexible alternative to activeBasePath and takes precedence over it -- Docusaurus parses it into a regular expression that is tested against the current URL.

Outbound (external) links automatically get target="_blank" rel="noopener noreferrer" attributes.

Accepted fields:

Name	Type	Default	Description
`type`	`'default'`	Optional	Sets the type of this item to a link.
`label`	`string`	Required	The name to be shown for this item.
`to`	`string`	Required	Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value.
`href`	`string`	Required	A full-page navigation, used for navigating outside of the website. Only one of `to` or `href` should be used.
`prependBaseUrlToHref`	`boolean`	`false`	Prepends the baseUrl to `href` values.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.
`activeBasePath`	`string`	`to` / `href`	To apply the active class styling on all routes starting with this path. This usually isn't necessary.
`activeBaseRegex`	`string`	`undefined`	Alternative to `activeBasePath` if required.
`className`	`string`	`''`	Custom CSS class (for styling any item).

note

In addition to the fields above, you can specify other arbitrary attributes that can be applied to a HTML link.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          to: 'docs/introduction',
          // Only one of "to" or "href" should be used
          // href: 'https://www.facebook.com',
          label: 'Introduction',
          position: 'left',
          activeBaseRegex: 'docs/(next|v8)',
          target: '_blank',
        },
      ],
    },
  },
};

Navbar items of the type dropdown has the additional items field, an inner array of navbar items.

Navbar dropdown items only accept the following "link-like" item types:

Navbar link
Navbar doc link
Navbar docs version

Note that the dropdown base item is a clickable link as well, so this item can receive any of the props of a plain navbar link.

Accepted fields:

Name	Type	Default	Description
`type`	`'dropdown'`	Optional	Sets the type of this item to a dropdown.
`label`	`string`	Required	The name to be shown for this item.
`items`	`LinkLikeItem[]`	Required	The items to be contained in the dropdown.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'dropdown',
          label: 'Community',
          position: 'left',
          items: [
            {
              label: 'Facebook',
              href: 'https://www.facebook.com',
            },
            {
              type: 'doc',
              label: 'Social',
              docId: 'social',
            },
            // ... more items
          ],
        },
      ],
    },
  },
};

If you want to link to a specific doc, this special navbar item type will render the link to the doc of the provided docId. It will get the class navbar__link--active as long as you browse a doc of the same sidebar.

Accepted fields:

Name	Type	Default	Description
`type`	`'doc'`	Required	Sets the type of this item to a doc link.
`docId`	`string`	Required	The ID of the doc that this item links to.
`label`	`string`	`docId`	The name to be shown for this item.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.
`docsPluginId`	`string`	`'default'`	The ID of the docs plugin that the doc belongs to.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'doc',
          position: 'left',
          docId: 'introduction',
          label: 'Docs',
        },
      ],
    },
  },
};

If you use docs with versioning, this special navbar item type that will render a dropdown with all your site's available versions.

The user will be able to switch from one version to another, while staying on the same doc (as long as the doc id is constant across versions).

Accepted fields:

Name	Type	Default	Description
`type`	`'docsVersionDropdown'`	Required	Sets the type of this item to a docs version dropdown.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.
`dropdownItemsBefore`	`LinkLikeItem[]`	`[]`	Add additional dropdown items at the beginning of the dropdown.
`dropdownItemsAfter`	`LinkLikeItem[]`	`[]`	Add additional dropdown items at the end of the dropdown.
`docsPluginId`	`string`	`'default'`	The ID of the docs plugin that the doc versioning belongs to.
`dropdownActiveClassDisabled`	`boolean`	`false`	Do not add the link active class when browsing docs.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'docsVersionDropdown',
          position: 'left',
          dropdownItemsAfter: [{to: '/versions', label: 'All versions'}],
          dropdownActiveClassDisabled: true,
        },
      ],
    },
  },
};

If you use docs with versioning, this special navbar item type will link to the active/browsed version of your doc (depends on the current URL), and fallback to the latest version.

Accepted fields:

Name	Type	Default	Description
`type`	`'docsVersion'`	Required	Sets the type of this item to a doc version link.
`label`	`string`	The active/latest version label.	The name to be shown for this item.
`to`	`string`	The active/latest version.	The internal link that this item points to.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.
`docsPluginId`	`string`	`'default'`	The ID of the docs plugin that the doc versioning belongs to.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'docsVersion',
          position: 'left',
          to: '/path',
          label: 'label',
        },
      ],
    },
  },
};

If you use the i18n feature, this special navbar item type will render a dropdown with all your site's available locales.

The user will be able to switch from one locale to another, while staying on the same page.

Accepted fields:

Name	Type	Default	Description
`type`	`'localeDropdown'`	Required	Sets the type of this item to a locale dropdown.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.
`dropdownItemsBefore`	`LinkLikeItem[]`	`[]`	Add additional dropdown items at the beginning of the dropdown.
`dropdownItemsAfter`	`LinkLikeItem[]`	`[]`	Add additional dropdown items at the end of the dropdown.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'localeDropdown',
          position: 'left',
          dropdownItemsAfter: [
            {
              to: 'https://my-site.com/help-us-translate',
              label: 'Help us translate',
            },
          ],
        },
      ],
    },
  },
};

If you use the search, the search bar will be the rightmost element in the navbar.

However, with this special navbar item type, you can change the default location.

Name	Type	Default	Description
`type`	`'search'`	Required	Sets the type of this item to a search bar.
`position`	`'left' \| 'right'`	`'left'`	The side of the navbar this item should appear on.

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      items: [
        {
          type: 'search',
          position: 'right',
        },
      ],
    },
  },
};

You can enable this cool UI feature that automatically hides the navbar when a user starts scrolling down the page, and show it again when the user scrolls up.

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      hideOnScroll: true,
    },
  },
};

You can set the static Navbar style without disabling the theme switching ability. The selected style will always apply no matter which theme user have selected.

Currently, there are two possible style options: dark and primary (based on the --ifm-color-primary color). You can see the styles preview in the Infima documentation.

docusaurus.config.js

module.exports = {
  themeConfig: {
    navbar: {
      style: 'primary',
    },
  },
};

CodeBlock

Docusaurus uses Prism React Renderer to highlight code blocks. All configuration are in the prism object.

Accepted fields:

Name	Type	Default	Description
`theme`	`PrismTheme`	`palenight`	The Prism theme to use for light-theme code blocks.
`darkTheme`	`PrismTheme`	`palenight`	The Prism theme to use for dark-theme code blocks.
`defaultLanguage`	`string`	`undefined`	The side of the navbar this item should appear on.

Theme

By default, we use Palenight as syntax highlighting theme. You can specify a custom theme from the list of available themes. You may also use a different syntax highlighting theme when the site is in dark mode.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    prism: {
      theme: require('prism-react-renderer/themes/github'),
      darkTheme: require('prism-react-renderer/themes/dracula'),
    },
  },
};

note

If you use the line highlighting Markdown syntax, you might need to specify a different highlight background color for the dark mode syntax highlighting theme. Refer to the docs for guidance.

Default language

You can set a default language for code blocks if no language is added after the opening triple backticks (i.e. ```). Note that a valid language name must be passed.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    prism: {
      defaultLanguage: 'javascript',
    },
  },
};

You can add logo and a copyright to the footer via themeConfig.footer. Logo can be placed in static folder. Logo URL works in the same way of the navbar logo.

Accepted fields:

Name	Type	Default	Description
`logo`	`Logo`	`undefined`	Customization of the logo object. See Navbar logo for details.
`copyright`	`string`	`undefined`	The copyright message to be displayed at the bottom.
`style`	`'dark' \| 'light'`	`'light'`	The color theme of the footer component.
`items`	`FooterItem[]`	`[]`	The link groups to be present.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    footer: {
      logo: {
        alt: 'Facebook Open Source Logo',
        src: 'img/oss_logo.png',
        href: 'https://opensource.facebook.com',
        width: 160,
        height: 51,
      },
      copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
    },
  },
};

You can add links to the footer via themeConfig.footer.links.

Accepted fields of each link section:

Name	Type	Default	Description
`title`	`string`	`undefined`	Label of the section of these links.
`items`	`FooterLink[]`	`[]`	Links in this section.

Accepted fields of each item in items:

Name	Type	Default	Description
`label`	`string`	Required	Text to be displayed for this link.
`to`	`string`	Required	Client-side routing, used for navigating within the website. The baseUrl will be automatically prepended to this value.
`href`	`string`	Required	A full-page navigation, used for navigating outside of the website. Only one of `to` or `href` should be used.
`html`	`string`	`undefined`	Renders the html pass-through instead of a simple link. In case `html` is used, no other options should be provided.

Example configuration:

docusaurus.config.js

module.exports = {
  footer: {
    links: [
      {
        title: 'Docs',
        items: [
          {
            label: 'Style Guide',
            to: 'docs/',
          },
          {
            label: 'Second Doc',
            to: 'docs/doc2/',
          },
        ],
      },
      {
        title: 'Community',
        items: [
          {
            label: 'Stack Overflow',
            href: 'https://stackoverflow.com/questions/tagged/docusaurus',
          },
          {
            label: 'Discord',
            href: 'https://discordapp.com/invite/docusaurus',
          },
          {
            label: 'Twitter',
            href: 'https://twitter.com/docusaurus',
          },
          {
            html: `
                <a href="https://www.netlify.com" target="_blank" rel="noreferrer noopener" aria-label="Deploys by Netlify">
                  <img src="https://www.netlify.com/img/global/badges/netlify-color-accent.svg" alt="Deploys by Netlify" />
                </a>
              `,
          },
        ],
      },
    ],
  },
};

You can adjust the default table of contents via themeConfig.tableOfContents.

Name	Type	Default	Description
`minHeadingLevel`	`number`	`2`	The minimum heading level shown in the table of contents. Must be between 2 and 6 and lower or equal to the max value.
`maxHeadingLevel`	`number`	`3`	Max heading level displayed in the TOC. Should be an integer between 2 and 6.

Example configuration:

docusaurus.config.js

module.exports = {
  themeConfig: {
    tableOfContents: {
      minHeadingLevel: 2,
      maxHeadingLevel: 5,
    },
  },
};

Hooks

`useThemeContext`

React hook to access theme context. This context contains functions for setting light and dark mode and exposes boolean variable, indicating which mode is currently in use.

Usage example:

import React from 'react';
import useThemeContext from '@theme/hooks/useThemeContext';

const Example = () => {
  const {isDarkTheme, setLightTheme, setDarkTheme} = useThemeContext();

  return <h1>Dark mode is now {isDarkTheme ? 'on' : 'off'}</h1>;
};

note

The component calling useThemeContext must be a child of the Layout component.

function ExamplePage() {
  return (
    <Layout>
      <Example />
    </Layout>
  );
}

i18n

Read the i18n introduction first.

Translation files location

Base path: website/i18n/<locale>/docusaurus-theme-<themeName>
Multi-instance path: N/A
JSON files: extracted with docusaurus write-translations
Markdown files: N/A

Example file-system structure

website/i18n/<locale>/docusaurus-theme-classic
│
│ # translations for the theme
├── navbar.json
└── footer.json

Theme configuration

Common

Color mode

caution

Meta image

Metadata

Announcement bar

Navbar

Navbar logo

Navbar items

Navbar link

note

Navbar doc link

Navbar docs version

Navbar search

Auto-hide sticky navbar

Navbar style

CodeBlock

Theme

note

Default language

Footer

Footer Links

Table of Contents

Hooks

`useThemeContext`

note

i18n

Translation files location

Example file-system structure

Common​

Color mode​

caution

Meta image​

Metadata​

Announcement bar​

Navbar​

Navbar logo​

Navbar items​

Navbar link​

note

Navbar dropdown​

Navbar doc link​

Navbar docs version dropdown​

Navbar docs version​

Navbar locale dropdown​

Navbar search​

Auto-hide sticky navbar​

Navbar style​

CodeBlock​

Theme​

note

Default language​

Footer​

Footer Links​

Table of Contents​

Hooks​

useThemeContext​

note

i18n​

Translation files location​

Example file-system structure​

Common

Color mode

Meta image

Metadata

Announcement bar

Navbar

Navbar logo

Navbar items

Navbar link

Navbar dropdown

Navbar doc link

Navbar docs version dropdown

Navbar docs version

Navbar locale dropdown

Navbar search

Auto-hide sticky navbar

Navbar style

CodeBlock

Theme

Default language

Footer

Footer Links

Table of Contents

Hooks

`useThemeContext`

i18n

Translation files location

Example file-system structure