MkDocs is a smart, simple, website design tool.
Getting started is easy...
$ pip install mkdocs --preThis will install the version 2.0 pre-release.
- Create a
docs/README.mdpage. - Run
mkdocs serveto view your documentation in a browser. - Run
mkdocs buildto build a static website ready to host.
- Create additional markdown pages.
- Use relative interlinking between pages.
- Include images and use relative interlinking from pages.
MkDocs supports GitHub Flavored Markdown for page authoring.
- Create a
templates/base.htmlto customise the styling. - 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.title }}</title>
<link rel="stylesheet" href="{{ '/css/default.css' | url }}">
</head>
<body>
<main>
{{ page.html }}
</main>
</body>
</html>