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
1 maintainer
Release files for mknodes 2.2.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mknodes-2.2.14.tar.gz | 342.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mknodes-2.2.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 815.3 kB
Release files / mknodes-2.2.14.tar.gz
| Download URL | mknodes-2.2.14.tar.gz |
|---|---|
| Size | 342.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ab572a394121b309c05f572ad96f14e9c6defab5a3f7dfe7e8d95ea8168be4c6
|
|
BLAKE2b-256 checksum How to use checksums |
124d0fc0269801c55d3d434b391cd99b518a7e5a59739376b3db23ff6037cd55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|
Release files / mknodes-2.2.14-py3-none-any.whl
| Download URL | mknodes-2.2.14-py3-none-any.whl |
|---|---|
| Size | 472.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce544198ff5fcd29ad6b258877e8cbe76ea86cd9e4fde4fbb3f6afb843681baa
|
|
BLAKE2b-256 checksum How to use checksums |
83658e0828b326c2b50e95ba5d2dd5e9fe807acf45bdf96482e0d6d09deee8be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|
