mknodes 2.2.14

Don't write docs. Code them.

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