mkdocs-mknodes

Name	mkdocs-mknodes JSON
Version	0.7.2 JSON
	download
home_page	None
Summary	Don't write docs. Code them.
upload_time	2024-11-10 17:16:37
maintainer	None
docs_url	None
author	None
requires_python	>=3.12
license	None
keywords	docs docstrings documentation framework internet markdown
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ``` 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

```

# MkNodes (Mkdocs Plugin)

#### Don't write docs. Code them.

[![PyPI License](https://img.shields.io/pypi/l/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Package status](https://img.shields.io/pypi/status/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Daily downloads](https://img.shields.io/pypi/dd/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Weekly downloads](https://img.shields.io/pypi/dw/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Monthly downloads](https://img.shields.io/pypi/dm/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Distribution format](https://img.shields.io/pypi/format/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Wheel availability](https://img.shields.io/pypi/wheel/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Python version](https://img.shields.io/pypi/pyversions/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Implementation](https://img.shields.io/pypi/implementation/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)
[![Releases](https://img.shields.io/github/downloads/phil65/mkdocs_mknodes/total.svg)](https://github.com/phil65/mkdocs_mknodes/releases)
[![Github Contributors](https://img.shields.io/github/contributors/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)
[![Github Discussions](https://img.shields.io/github/discussions/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/discussions)
[![Github Forks](https://img.shields.io/github/forks/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/forks)
[![Github Issues](https://img.shields.io/github/issues/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/issues)
[![Github Issues](https://img.shields.io/github/issues-pr/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/pulls)
[![Github Watchers](https://img.shields.io/github/watchers/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/watchers)
[![Github Stars](https://img.shields.io/github/stars/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/stars)
[![Github Repository size](https://img.shields.io/github/repo-size/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)
[![Github last commit](https://img.shields.io/github/last-commit/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/commits)
[![Github release date](https://img.shields.io/github/release-date/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/releases)
[![Github language count](https://img.shields.io/github/languages/count/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)
[![Github commits this week](https://img.shields.io/github/commit-activity/w/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)
[![Github commits this month](https://img.shields.io/github/commit-activity/m/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)
[![Github commits this year](https://img.shields.io/github/commit-activity/y/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)
[![Package status](https://codecov.io/gh/phil65/mkdocs_mknodes/branch/main/graph/badge.svg)](https://codecov.io/gh/phil65/mkdocs_mknodes/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![PyUp](https://pyup.io/repos/github/phil65/mkdocs_mknodes/shield.svg)](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)

[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)

## How to install

### pip

The latest released version is available at the [Python package index](https://pypi.org/project/mknodes).

``` py
pip install mkdocs-mknodes
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-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/da/a2/48ecd964e2721f9057035675f87cd609222773791f273c96980b388df162/mkdocs_mknodes-0.7.2.tar.gz",
    "platform": null,
    "description": "``` 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# MkNodes (Mkdocs Plugin)\n\n#### Don't write docs. Code them.\n\n[![PyPI License](https://img.shields.io/pypi/l/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Package status](https://img.shields.io/pypi/status/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Daily downloads](https://img.shields.io/pypi/dd/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Weekly downloads](https://img.shields.io/pypi/dw/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Monthly downloads](https://img.shields.io/pypi/dm/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Distribution format](https://img.shields.io/pypi/format/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Wheel availability](https://img.shields.io/pypi/wheel/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Python version](https://img.shields.io/pypi/pyversions/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Implementation](https://img.shields.io/pypi/implementation/mkdocs-mknodes.svg)](https://pypi.org/project/mkdocs-mknodes/)\n[![Releases](https://img.shields.io/github/downloads/phil65/mkdocs_mknodes/total.svg)](https://github.com/phil65/mkdocs_mknodes/releases)\n[![Github Contributors](https://img.shields.io/github/contributors/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/graphs/contributors)\n[![Github Discussions](https://img.shields.io/github/discussions/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/discussions)\n[![Github Forks](https://img.shields.io/github/forks/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/forks)\n[![Github Issues](https://img.shields.io/github/issues/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/issues)\n[![Github Issues](https://img.shields.io/github/issues-pr/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/pulls)\n[![Github Watchers](https://img.shields.io/github/watchers/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/watchers)\n[![Github Stars](https://img.shields.io/github/stars/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/stars)\n[![Github Repository size](https://img.shields.io/github/repo-size/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)\n[![Github last commit](https://img.shields.io/github/last-commit/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/commits)\n[![Github release date](https://img.shields.io/github/release-date/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes/releases)\n[![Github language count](https://img.shields.io/github/languages/count/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)\n[![Github commits this week](https://img.shields.io/github/commit-activity/w/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)\n[![Github commits this month](https://img.shields.io/github/commit-activity/m/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)\n[![Github commits this year](https://img.shields.io/github/commit-activity/y/phil65/mkdocs_mknodes)](https://github.com/phil65/mkdocs_mknodes)\n[![Package status](https://codecov.io/gh/phil65/mkdocs_mknodes/branch/main/graph/badge.svg)](https://codecov.io/gh/phil65/mkdocs_mknodes/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![PyUp](https://pyup.io/repos/github/phil65/mkdocs_mknodes/shield.svg)](https://pyup.io/repos/github/phil65/mkdocs_mknodes/)\n\n[Read the completely coded documentation!](https://phil65.github.io/mkdocs-mknodes/)\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 mkdocs-mknodes\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Don't write docs. Code them.",
    "version": "0.7.2",
    "project_urls": {
        "Documentation": "https://phil65.github.io/mkdocs-mknodes/",
        "Gitter": "https://app.gitter.im/#/room/#mknodes:gitter.im",
        "Source": "https://github.com/phil65/mkdocs_mknodes"
    },
    "split_keywords": [
        "docs",
        " docstrings",
        " documentation",
        " framework",
        " internet",
        " markdown"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "dbb7ecd7ee1a0e771269df6e26d3a1b97e2ac9a362bc522a8d43147b4c534c29",
                "md5": "7c3be22e06964ae8de4999cbec788c05",
                "sha256": "910a49fc07d2050bf5219ca14d21b56b9ac2249be5bdc231f6ed944b767a25dc"
            },
            "downloads": -1,
            "filename": "mkdocs_mknodes-0.7.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c3be22e06964ae8de4999cbec788c05",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 65059,
            "upload_time": "2024-11-10T17:16:35",
            "upload_time_iso_8601": "2024-11-10T17:16:35.138328Z",
            "url": "https://files.pythonhosted.org/packages/db/b7/ecd7ee1a0e771269df6e26d3a1b97e2ac9a362bc522a8d43147b4c534c29/mkdocs_mknodes-0.7.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "daa248ecd964e2721f9057035675f87cd609222773791f273c96980b388df162",
                "md5": "5bf7408c4e3bf6b7826504a50d9b0b35",
                "sha256": "4d04db6a5834196cac111f98cf5a3d87c83f6563f3184421acd80abc9eda3796"
            },
            "downloads": -1,
            "filename": "mkdocs_mknodes-0.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "5bf7408c4e3bf6b7826504a50d9b0b35",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 289905,
            "upload_time": "2024-11-10T17:16:37",
            "upload_time_iso_8601": "2024-11-10T17:16:37.149034Z",
            "url": "https://files.pythonhosted.org/packages/da/a2/48ecd964e2721f9057035675f87cd609222773791f273c96980b388df162/mkdocs_mknodes-0.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-10 17:16:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "phil65",
    "github_project": "mkdocs_mknodes",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-mknodes"
}