Skip to content

Introduction to MkDocs

MkDocs is a fast, simple, and open-source static site generator designed for building project documentation. Written in Python, it allows you to write documentation in Markdown and generate a responsive website with minimal configuration.

Key Features

  • Easy to use and configure
  • Markdown-based documentation
  • Built-in themes and customization options
  • Instant preview with live-reload server

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.

Learn more at mkdocs.org.