| Name | mknodes JSON |
| Version |
0.54.4
JSON |
| download |
| home_page | None |
| Summary | Don't write docs. Code them. |
| upload_time | 2024-11-16 20:01:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024, Philipp Temminghoff Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
docs
docstrings
documentation
framework
internet
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.12",
"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/4e/5e/78c0bede6e1e933b896c1e01d70b58730dcf19d15b95de9180d73b04622e/mknodes-0.54.4.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": "MIT License Copyright (c) 2024, Philipp Temminghoff Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Don't write docs. Code them.",
"version": "0.54.4",
"project_urls": {
"Documentation": "https://phil65.github.io/mknodes/",
"Source": "https://github.com/phil65/mknodes"
},
"split_keywords": [
"docs",
" docstrings",
" documentation",
" framework",
" internet",
" markdown"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "29a8829b64f299876288fd7bf0501c416b862ff9eedbb673d04be5cf4a7672cb",
"md5": "0da0b420f0e96889f803a4502a71c078",
"sha256": "815246644e62b2b815df2bb7d9e8848f7eb1119b901dc49cc96b5444f57b6d11"
},
"downloads": -1,
"filename": "mknodes-0.54.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0da0b420f0e96889f803a4502a71c078",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 1503180,
"upload_time": "2024-11-16T20:00:59",
"upload_time_iso_8601": "2024-11-16T20:00:59.364170Z",
"url": "https://files.pythonhosted.org/packages/29/a8/829b64f299876288fd7bf0501c416b862ff9eedbb673d04be5cf4a7672cb/mknodes-0.54.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4e5e78c0bede6e1e933b896c1e01d70b58730dcf19d15b95de9180d73b04622e",
"md5": "c92d0c97ae1b79bb4fc45bbc663f2ce9",
"sha256": "ba0003f72ab8a4c56b674cbfd420002de89f970a7922832a0e2e6ec8997501ba"
},
"downloads": -1,
"filename": "mknodes-0.54.4.tar.gz",
"has_sig": false,
"md5_digest": "c92d0c97ae1b79bb4fc45bbc663f2ce9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 938687,
"upload_time": "2024-11-16T20:01:01",
"upload_time_iso_8601": "2024-11-16T20:01:01.826817Z",
"url": "https://files.pythonhosted.org/packages/4e/5e/78c0bede6e1e933b896c1e01d70b58730dcf19d15b95de9180d73b04622e/mknodes-0.54.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 20:01:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "phil65",
"github_project": "mknodes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mknodes"
}
