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.
Getting started is easy...
$ 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.dev4
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.dev4.tar.gz | 404.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs-2.0.dev4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 413.4 kB
Release files / mkdocs-2.0.dev4.tar.gz
| Download URL | mkdocs-2.0.dev4.tar.gz |
|---|---|
| Size | 404.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4b04842943f9952ce2c10476f1044a55ef1f4d142c4a60277b4ed448684db870
|
|
BLAKE2b-256 checksum How to use checksums |
6e2b4284a4e172f5ce2094e0d9265c59c25ca39984ad16121c274d83d87f20b4
|
| 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.dev4-py3-none-any.whl
| Download URL | mkdocs-2.0.dev4-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
961d965b6c7426d39509a82dda390b695e86f19cf7dc324d86f543fc8806b88c
|
|
BLAKE2b-256 checksum How to use checksums |
67bcbdb196bfad68b699a60e83c1b90f6129956092b51b3dd695052d39ee17d1
|
| 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}
|
