This is an example theme for MkDocs.

It is designed to be read by looking at the theme HTML which is heavily commented. The easiest way to do that is by looking at the source on GitHub.. Otherwise this is just a demonstration that the theme is fully functional.

Documentation Navigation

• MkDocs Basic Theme
• About
  • Contributing
  • License
  • Release notes
    • Version 1 Release Notes
    • Version 2 Release Notes
• User guide
  • Configuration
  • Custom Themes
  • Deploying Your Docs
  • Styling Your Docs
  • Writing Your Docs

Support for search

Next and previous links

Link to the source

Show the table of contents for the current page

• MkDocs Basic Theme
• Adapting this theme

MkDocs Basic Theme

This is a very basic theme for MkDocs with the goal of demonstrating all of the features with minimal HTML and CSS.

Adapting this theme

If you want to use this theme as a base to create your own, it is best to download or fork the theme and start to modify it

Make sure you read the MkDocs documentation regarding writing custom themes.