Home

Created on January 13, 2023 — updated on August 18, 2026

For full documentation visit mkdocs.org.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Installing and activating the theme

See Getting Started for installing MkDocs, installing the theme, and activating it in mkdocs.yml.

Getting Help

We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them. If you need anything, I ask you to please follow our templates for opening issues or discussions.

• 🐛 Bug Report
• 📕 Documentation Issue
• 🚀 Feature Request
• ⚠️ Security Request
• 💬 General Question

Contributing

See the Development Guide for commit style conventions and license information.