Customization#

For details about standard mkdocs options, see MkDocs Configuration.

In addition, this theme supports a few additional options.

theme configuration options#

Located on the theme key in your mkdocs.yml:

• home: Sets the initial landing page.

• main_color: Sets the main theme color of the site. This should be a somewhat dark color as it is also used for links.

• gray: Sets the gray tone used for some borders.

• lighter_gray: Sets the gray tone used for various backgrounds.

• date_time_format: Date and time formatting used for the time stamps at the bottom of pages. Formatting is implemented using strftime.

• toc_depth: The levels of headings to include in the table of contents in the navigation pane for the currently open page.

extra configuration options#

Located on the extra key in your mkdocs.yml:

• logo: Path to a logo to include in the top bar next to the site name.

• version: Version number to include right under the site name.

• article_nav_top: Set to false to hide the Previous/Next navigation buttons above article contents.

• article_nav_bottom: Set to false to hide the Previous/Next navigation buttons below article contents.

• history_buttons: Include back/forward buttons in the top bar. This is useful when the documentation site is included into a bare browser, e.g. into an Electron-based application.

• nav_links: This defines the custom links above the table of contents. It is a list of objects with the following fields:

  • icon: This indicates to what you link by using the given value as a FontAwesome icon. Possible values include github, twitter, facebook, slack and a lot more!
  • icon_type: This defines the FontAwesome icon class. You'll need to set this to brand to make use of brand icons like twitter. brand internally sets the fab class instead of the fa class.
  • text: This sets the text that is being displayed
  • url: Sets the links href