Home

September 7, 2025

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.

Installation MkDocs

To install MkDocs, run the following command from the command line:

pip install mkdocs

Installation theme

Install the theme using PIP:

pip install mkdocs-mini-blog

Activating theme

After the theme is installed, edit your mkdocs.yml file and set the theme name to mini-blog:

theme:
    name: mini-blog

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
• 💬 General Question

License

This project is licensed under the terms of the MIT License.