MkNodes
Don't write docs. Code them.
Read the completely coded documentation!
Programatically create web pages
def create_github_index_md() -> mk.MkPage:
page = mk.MkPage("Github index")
page += mk.MkCode.for_object(create_github_index_md)
page += mk.MkHeader("MkNodes", level=1)
page += mk.MkHeader("Don't write docs. Code them.", level=4)
page += mk.MkShields()
page += mk.MkLink(DOC_URL, "Read the completely coded documentation!")
page += mk.MkInstallGuide(header="How to install")
page += mk.MkHeader("All the nodes!")
page += mk.MkClassDiagram(mk.MkNode, mode="subclasses", direction="LR")
return page
Create a website tree
@nav.route.page("Changelog", icon="format-list-group")
def _(page: mk.MkPage):
page += mk.MkChangelog()
Powerful templating
{{ "Inlined text" | MkAdmonition(inline="left") }}
Execute Python code in markdown
print("# Generated at build time!")
print("Current timestamp:", __import__('datetime').datetime.now())
Use session="name" to persist variables between code blocks:
counter = 1
print(f"Counter is now: {counter + 1}")
How to install
pip
The latest released version is available at the Python package index.
pip install mknodes
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mknodes-2.2.14.tar.gz
(342.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
mknodes-2.2.14-py3-none-any.whl
(472.6 kB
view details)
File details
Details for the file mknodes-2.2.14.tar.gz.
File metadata
- Download URL: mknodes-2.2.14.tar.gz
- Upload date:
- Size: 342.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ab572a394121b309c05f572ad96f14e9c6defab5a3f7dfe7e8d95ea8168be4c6
|
|
| MD5 |
0c11e666f4180f121313ab76612c35f6
|
|
| BLAKE2b-256 |
124d0fc0269801c55d3d434b391cd99b518a7e5a59739376b3db23ff6037cd55
|
File details
Details for the file mknodes-2.2.14-py3-none-any.whl.
File metadata
- Download URL: mknodes-2.2.14-py3-none-any.whl
- Upload date:
- Size: 472.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.10","id":"questing","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce544198ff5fcd29ad6b258877e8cbe76ea86cd9e4fde4fbb3f6afb843681baa
|
|
| MD5 |
229aab03337104a2c068ed4eaeb2c740
|
|
| BLAKE2b-256 |
83658e0828b326c2b50e95ba5d2dd5e9fe807acf45bdf96482e0d6d09deee8be
|