# MkNodes
#### Don't write docs. Code them.
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://pypi.org/project/mknodes/)
[](https://github.com/phil65/mknodes/releases)
[](https://github.com/phil65/mknodes/graphs/contributors)
[](https://github.com/phil65/mknodes/discussions)
[](https://github.com/phil65/mknodes/forks)
[](https://github.com/phil65/mknodes/issues)
[](https://github.com/phil65/mknodes/pulls)
[](https://github.com/phil65/mknodes/watchers)
[](https://github.com/phil65/mknodes/stars)
[](https://github.com/phil65/mknodes)
[](https://github.com/phil65/mknodes/commits)
[](https://github.com/phil65/mknodes/releases)
[](https://github.com/phil65/mknodes)
[](https://github.com/phil65/mknodes)
[](https://github.com/phil65/mknodes)
[](https://github.com/phil65/mknodes)
[](https://codecov.io/gh/phil65/mknodes/)
[](https://pyup.io/repos/github/phil65/mknodes/)
[Read the completely coded documentation!](https://phil65.github.io/mknodes/)
## Programatically create web pages
``` py title='__main__.create_github_index_md' linenums="86" hl_lines="3"
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
``` py
@nav.route.page("Changelog", icon="format-list-group")
def _(page: mk.MkPage):
page += mk.MkChangelog()
```
## Powerful templating
``` jinja
{{ "Inlined text" | MkAdmonition(inline="left") }}
```
## How to install
### pip
The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).
``` py
pip install mknodes
```
Raw data
{
"_id": null,
"home_page": null,
"name": "mknodes",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "docs,docstrings,documentation,framework,internet,markdown",
"author": null,
"author_email": "Philipp Temminghoff <philipptemminghoff@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/42/80/cdb1c389df54ace4d0924ebe01b336b01ce03ad65dc95e9c5733a54d4445/mknodes-0.52.11.tar.gz",
"platform": null,
"description": "# MkNodes\n\n#### Don't write docs. Code them.\n\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://pypi.org/project/mknodes/)\n[](https://github.com/phil65/mknodes/releases)\n[](https://github.com/phil65/mknodes/graphs/contributors)\n[](https://github.com/phil65/mknodes/discussions)\n[](https://github.com/phil65/mknodes/forks)\n[](https://github.com/phil65/mknodes/issues)\n[](https://github.com/phil65/mknodes/pulls)\n[](https://github.com/phil65/mknodes/watchers)\n[](https://github.com/phil65/mknodes/stars)\n[](https://github.com/phil65/mknodes)\n[](https://github.com/phil65/mknodes/commits)\n[](https://github.com/phil65/mknodes/releases)\n[](https://github.com/phil65/mknodes)\n[](https://github.com/phil65/mknodes)\n[](https://github.com/phil65/mknodes)\n[](https://github.com/phil65/mknodes)\n[](https://codecov.io/gh/phil65/mknodes/)\n[](https://pyup.io/repos/github/phil65/mknodes/)\n\n[Read the completely coded documentation!](https://phil65.github.io/mknodes/)\n\n\n\n## Programatically create web pages\n\n``` py title='__main__.create_github_index_md' linenums=\"86\" hl_lines=\"3\"\ndef create_github_index_md() -> mk.MkPage:\n page = mk.MkPage(\"Github index\")\n page += mk.MkCode.for_object(create_github_index_md)\n page += mk.MkHeader(\"MkNodes\", level=1)\n page += mk.MkHeader(\"Don't write docs. Code them.\", level=4)\n page += mk.MkShields()\n page += mk.MkLink(DOC_URL, \"Read the completely coded documentation!\")\n page += mk.MkInstallGuide(header=\"How to install\")\n page += mk.MkHeader(\"All the nodes!\")\n page += mk.MkClassDiagram(mk.MkNode, mode=\"subclasses\", direction=\"LR\")\n return page\n\n```\n\n\n## Create a website tree\n\n\n``` py\n@nav.route.page(\"Changelog\", icon=\"format-list-group\")\ndef _(page: mk.MkPage):\n page += mk.MkChangelog()\n```\n\n\n## Powerful templating\n\n\n``` jinja\n{{ \"Inlined text\" | MkAdmonition(inline=\"left\") }}\n```\n\n\n\n\n## How to install\n\n### pip\n\nThe latest released version is available at the [Python package index](https://pypi.org/project/mknodes).\n\n``` py\npip install mknodes\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Don't write docs. Code them.",
"version": "0.52.11",
"project_urls": {
"Documentation": "https://phil65.github.io/mknodes/",
"Gitter": "https://app.gitter.im/#/room/#mknodes:gitter.im",
"Source": "https://github.com/phil65/mknodes"
},
"split_keywords": [
"docs",
"docstrings",
"documentation",
"framework",
"internet",
"markdown"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fa88b94a636e65f1b27f6ebdae71843700edae53e0e636dead1145b7c2a2c3a0",
"md5": "4a325b90a63cc526f7d326f38fb07795",
"sha256": "3eca9750a0168d1257ef775c6fcb2e71f4848bdd0f6ee09dbc919eee6df5f6b2"
},
"downloads": -1,
"filename": "mknodes-0.52.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a325b90a63cc526f7d326f38fb07795",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 3617009,
"upload_time": "2023-12-03T20:37:11",
"upload_time_iso_8601": "2023-12-03T20:37:11.688169Z",
"url": "https://files.pythonhosted.org/packages/fa/88/b94a636e65f1b27f6ebdae71843700edae53e0e636dead1145b7c2a2c3a0/mknodes-0.52.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4280cdb1c389df54ace4d0924ebe01b336b01ce03ad65dc95e9c5733a54d4445",
"md5": "ab188bc8084c168ed4a0492e58631408",
"sha256": "ff27e3eddbcbcf3e10dc62fc05958dcce33f75c49890529e8e411a9bb3160d26"
},
"downloads": -1,
"filename": "mknodes-0.52.11.tar.gz",
"has_sig": false,
"md5_digest": "ab188bc8084c168ed4a0492e58631408",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 3046483,
"upload_time": "2023-12-03T20:37:06",
"upload_time_iso_8601": "2023-12-03T20:37:06.208932Z",
"url": "https://files.pythonhosted.org/packages/42/80/cdb1c389df54ace4d0924ebe01b336b01ce03ad65dc95e9c5733a54d4445/mknodes-0.52.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-03 20:37:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phil65",
"github_project": "mknodes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mknodes"
}
JSON
