mkdocs-gentags

Name	mkdocs-gentags JSON
Version	0.0.1 JSON
	download
home_page	None
Summary	A mkdocs plugin to generate tag files based on metadata information.
upload_time	2024-05-18 16:35:44
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	None
keywords	mkdocs mkdocs-plugin plugin tag tagging tags
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-gentags

![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/tests.yml/badge.svg?branch=main)
![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/lint.yml/badge.svg?branch=main)
---

A [mkdocs][1] plugin to generate tags from metadata (aka frontmatter).

Generates virtual files for tags, and inject context in the page objects to
facilitate rendering in custom templates. The virtual files behave as normal
files, they can be linked, indexed and so on.

In particular, this plugin is useful for those who want to customize their tags page.

For more information, installation steps and examples, see the [documentation][2].

## Related

Similar plugins:

- https://github.com/jldiaz/mkdocs-plugin-tags
- https://github.com/timmeinerzhagen/mkdocs-meta-manager


[1]: https://www.mkdocs.org
[2]: https://georgeyk.github.io/mkdocs-gentags/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-gentags",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "mkdocs, mkdocs-plugin, plugin, tag, tagging, tags",
    "author": null,
    "author_email": "\"George Y. Kussumoto\" <georgeyk.dev@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/90/fd/5a7228d90cca061ba552f144cabbeee9229525bea405f97acea0c9ea8fe1/mkdocs_gentags-0.0.1.tar.gz",
    "platform": null,
    "description": "# mkdocs-gentags\n\n![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/tests.yml/badge.svg?branch=main)\n![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/lint.yml/badge.svg?branch=main)\n---\n\nA [mkdocs][1] plugin to generate tags from metadata (aka frontmatter).\n\nGenerates virtual files for tags, and inject context in the page objects to\nfacilitate rendering in custom templates. The virtual files behave as normal\nfiles, they can be linked, indexed and so on.\n\nIn particular, this plugin is useful for those who want to customize their tags page.\n\nFor more information, installation steps and examples, see the [documentation][2].\n\n## Related\n\nSimilar plugins:\n\n- https://github.com/jldiaz/mkdocs-plugin-tags\n- https://github.com/timmeinerzhagen/mkdocs-meta-manager\n\n\n[1]: https://www.mkdocs.org\n[2]: https://georgeyk.github.io/mkdocs-gentags/\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A mkdocs plugin to generate tag files based on metadata information.",
    "version": "0.0.1",
    "project_urls": {
        "Documentation": "https://github.com/georgeyk/mkdocs-gentags/#README.md",
        "Issues": "https://github.com/georgeyk/mkdocs-gentags/issues",
        "Source": "https://github.com/georgeyk/mkdocs-gentags"
    },
    "split_keywords": [
        "mkdocs",
        " mkdocs-plugin",
        " plugin",
        " tag",
        " tagging",
        " tags"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "fd445d25b0b1f9d57fe8f8c611ad1ca58e45e7ccc525b46cafa04c7e4c50993a",
                "md5": "4043989da6539c2e3a3339576dbd5855",
                "sha256": "740e5b3a97a529e12885e2108db1cac79a58e181dd71ee305c91093ce2467f17"
            },
            "downloads": -1,
            "filename": "mkdocs_gentags-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4043989da6539c2e3a3339576dbd5855",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4781,
            "upload_time": "2024-05-18T16:35:46",
            "upload_time_iso_8601": "2024-05-18T16:35:46.250488Z",
            "url": "https://files.pythonhosted.org/packages/fd/44/5d25b0b1f9d57fe8f8c611ad1ca58e45e7ccc525b46cafa04c7e4c50993a/mkdocs_gentags-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "90fd5a7228d90cca061ba552f144cabbeee9229525bea405f97acea0c9ea8fe1",
                "md5": "acc20b7677dd39aeb9201d141ec1020d",
                "sha256": "59acd374432fdd7c06a840f66137425a7925e18ce99f58ac1ea369ccbbdc6646"
            },
            "downloads": -1,
            "filename": "mkdocs_gentags-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "acc20b7677dd39aeb9201d141ec1020d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5287,
            "upload_time": "2024-05-18T16:35:44",
            "upload_time_iso_8601": "2024-05-18T16:35:44.103324Z",
            "url": "https://files.pythonhosted.org/packages/90/fd/5a7228d90cca061ba552f144cabbeee9229525bea405f97acea0c9ea8fe1/mkdocs_gentags-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-18 16:35:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "georgeyk",
    "github_project": "mkdocs-gentags",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-gentags"
}