📄 README.md

MkDocs

MkDocs is a smart, simple, website design tool.

Installation

Install the mkdocs command line tool...

$ pip install git+https://github.com/encode/mkdocs.git

This will install the version 2.0 pre-release.

Getting started

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

MkDocs supports GitHub Flavored Markdown for page authoring.

Writing your docs

Create additional markdown pages.
Use markdown interlinking between pages.
Create a mkdocs.toml file to define the site navigation and other configuration.
Move your markdown pages into a docs directory, and update the config.

An example mkdocs.toml...

[mkdocs]
nav = [
    {path="README.md", title="Introduction"},
    {path="CREDITS.md", title="Credits"},
]

[loaders]
theme = "pkg://mkdocs/default"
docs = "dir://docs"

[context]
title = "Documentation"
favicon = "📘"

Use either README.md or index.md for the homepage.

Custom styling

Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.

Configure the base theme for your project.
Modify the HTML templating to customise the layout.
Override or add CSS and JavaScript static assets.

Take a look at the default theme and the kelp theme for examples of getting started with theming.

The MkDocs documentation, served with the Kelp theme.