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.dev5
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.dev5.tar.gz | 122.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs-2.0.dev5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 131.9 kB
Release files / mkdocs-2.0.dev5.tar.gz
| Download URL | mkdocs-2.0.dev5.tar.gz |
|---|---|
| Size | 122.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
247c4aa65e2a7323c4868718562e298d264a17a4a1f46402aea1215ba950f44a
|
|
BLAKE2b-256 checksum How to use checksums |
49382ead054d22604ac2a4ed822cc44d86c0063cd48cf58893cb46adc7a32eec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","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.dev5-py3-none-any.whl
| Download URL | mkdocs-2.0.dev5-py3-none-any.whl |
|---|---|
| Size | 9.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2c36f1e7a2292a338e4826c460712889c049f9508402b54456971f398a2891ed
|
|
BLAKE2b-256 checksum How to use checksums |
ce769a4a091ef0294c906340cacc6519b335d82057244fd5764d777c14dcb9c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","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}
|
