MkDocs is a smart, simple, website design tool.

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

pip install mkdocs --pre

This will install the version 2.0 pre-release. For full installation steps, including using uv and troubleshooting common issues, see the Installation Guide.

1. Create a docs/README.md page.
2. Run mkdocs serve to view your documentation in a browser.
3. Run mkdocs build to build a static website ready to host.

1. Create additional markdown pages.
2. Use relative interlinking between pages.
3. Include images and use relative interlinking from pages.

MkDocs supports GitHub Flavored Markdown for page authoring.

1. Create a templates/base.html to customise the styling.
2. Include css and javascript to serve static files.

MkDocs uses Jinja templating for HTML rendering.

A starting point can be as simple as...

<html>
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <title>{{ page.toc.title }}</title>
        <link rel="stylesheet" href="{{ '/css/default.css' | url }}">
    </head>
    <body>
        <main>
            {{ page.html }}
        </main>
    </body>
</html>