MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information. There's a stack of good-looking themes available for MkDocs. Choose between the built in themes: mkdocs and readthedocs, select one of the third-party themes listed on the MkDocs Themes wiki page, or build your own. Get your project documentation looking just the way you want it by customizing your theme and/or installing some plugins. Modify Markdown's behavior with Markdown extensions. Many configuration options are available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.

Features

  • Great themes available
  • Easy to customize
  • Preview your site as you work
  • Host anywhere
  • MkDocs builds completely static HTML sites that you can host on GitHub pages
  • The built-in dev-server allows you to preview your documentation as you're writing it

Project Samples

Project Activity

See All Activity >

Categories

Documentation

License

BSD License

Follow MkDocs

MkDocs Web Site

Other Useful Business Software
$300 in Free Credit Towards Top Cloud Services Icon
$300 in Free Credit Towards Top Cloud Services

Build VMs, containers, AI, databases, storage—all in one place.

Start your project in minutes. After credits run out, 20+ products include free monthly usage. Only pay when you're ready to scale.
Get Started
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of MkDocs!

Additional Project Details

Programming Language

Python

Related Categories

Python Documentation Software

Registered

2022-09-06