Pre-release
This release is a pre-release and may not be stable for production use.
MkDocs
MkDocs is a smart, simple, website design tool.
Installation
To install MkDocs, run the following command from the command line:
pip install mkdocs --pre
This will install the version 2.0 pre-release.
Getting started
- Create a
docs/README.mdpage. - Run
mkdocs serveto view your documentation in a browser. - Run
mkdocs buildto build a static website ready to host.
Writing your docs
- 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.
Styling your docs
- 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.toc.title }}</title>
<link rel="stylesheet" href="{{ '/css/default.css' | url }}">
</head>
<body>
<main>
{{ page.html }}
</main>
</body>
</html>
2 maintainers
Release files for mkdocs 2.0.dev6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-2.0.dev6.tar.gz | 404.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs-2.0.dev6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 414.2 kB
Release files / mkdocs-2.0.dev6.tar.gz
| Download URL | mkdocs-2.0.dev6.tar.gz |
|---|---|
| Size | 404.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e2e064dea321b30601f5712d009695625ff505322753ca8e4c44ed8781dd57c0
|
|
BLAKE2b-256 checksum How to use checksums |
2c69e37c559e40b4fe0f76f2a59e2d501595493da5858f13c003ef5a6231b33d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / mkdocs-2.0.dev6-py3-none-any.whl
| Download URL | mkdocs-2.0.dev6-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2cc61ed3f32fccf6b297120e2a95fa05d5438a0cae3510969c33acc6f4517ffb
|
|
BLAKE2b-256 checksum How to use checksums |
6b0c7a01d7a4a1f21800e8dd6dddc4f3b68b255608b71f40d7062f9f25c25a7f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.4 {"installer":{"name":"uv","version":"0.11.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
