MkDocs

MkDocs is one of many Static Site Generators that use Markdown files to build a local html website. Unlike hugo and Jekyll, MkDocs is geared towards building project Documentation.

Resources

• MkDocs Installation Guide
• MkDocs Getting Started
• Getting Started with Material Theme
• Set up Multiple Languages with Material Theme

Features

• Great documentation themes available (ReadTheDocs, Material, and more)
• Highly customizable UI and functionalities via plugin, custom css, etc.
• Active community

MkDocs really shines when it comes to themes and plugins, they are what make the framework so versatile. So far I’ve been using plugins to support multiple languages, setup password protection, setup reusable text snippets and variables, generate API documentation, export content to pdf, etc. For more information on popular plugins, refer to the plugin catalog].

My Thoughts

• Easy to get into
• Great themes available
• Easily customizable
• Option to install additional functionality via plugins is amazing

Example Sites

• MkDocs Documentation
• Material Theme for MkDocs
  • FastAPI
  • Basler
  • Zenoss
  • Neptune.ai
  • Hummingbot
  • eccenca
  • Jitterbit
• Basic MkDocs Example Project with ReadTheDocs Theme

What I use it for

I introduced MkDocs and it’s theme Material as a new software documentation solution at work. We’ve migrated the existing Online Help and Knowledge Base of 6 products into a single MkDocs project.

For more information, refer to my blog post from April 2024: Migrating from Jekyll to MkDocs