mkdocs-meta-manager


Namemkdocs-meta-manager JSON
Version 0.2.1 PyPI version JSON
download
home_pagehttps://github.com/timmeinerzhagen/mkdocs-meta-manager
SummaryMkDocs plugin for managing meta tags across folders and files.
upload_time2023-03-24 13:26:53
maintainer
docs_urlNone
authorTim Jonas Meinerzhagen
requires_python>=3.4
licenseMIT
keywords mkdocs meta manager
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # mkdocs-meta-manager

MkDocs plugin for managing meta tags across folders and files

## Setup

1. Install the plugin:
    ```bash
    pip install mkdocs-meta-manager
    ```
2. Add the plugin to your `mkdocs.yml`
    ```bash
    plugins:
        - search
        - meta-manager
    ```

## Usage

Add meta files with the name `.meta.yml` (can be configured) in your docs file structure.

All markdown files in the same folder and in subfolders automatically get all tags that are defined in the given meta file.

## Options

`meta_filename`
Change the default name of the meta file. (default=`.meta.yml`)

`merge_tags`
Merge the tags of all relevant meta files and pages for a page (default=`false`)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/timmeinerzhagen/mkdocs-meta-manager",
    "name": "mkdocs-meta-manager",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.4",
    "maintainer_email": "",
    "keywords": "mkdocs meta manager",
    "author": "Tim Jonas Meinerzhagen",
    "author_email": "tim@meinerzhagen.me",
    "download_url": "https://files.pythonhosted.org/packages/2a/b3/45c519a28207caafcd133285a98adf60aaecdff43a93d63c9daafb9c60ab/mkdocs-meta-manager-0.2.1.tar.gz",
    "platform": null,
    "description": "# mkdocs-meta-manager\n\nMkDocs plugin for managing meta tags across folders and files\n\n## Setup\n\n1. Install the plugin:\n    ```bash\n    pip install mkdocs-meta-manager\n    ```\n2. Add the plugin to your `mkdocs.yml`\n    ```bash\n    plugins:\n        - search\n        - meta-manager\n    ```\n\n## Usage\n\nAdd meta files with the name `.meta.yml` (can be configured) in your docs file structure.\n\nAll markdown files in the same folder and in subfolders automatically get all tags that are defined in the given meta file.\n\n## Options\n\n`meta_filename`\nChange the default name of the meta file. (default=`.meta.yml`)\n\n`merge_tags`\nMerge the tags of all relevant meta files and pages for a page (default=`false`)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "MkDocs plugin for managing meta tags across folders and files.",
    "version": "0.2.1",
    "split_keywords": [
        "mkdocs",
        "meta",
        "manager"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e5e955d1f2f3879e0eec768bb2fbb330854d950736282d3919f6613a2d2caa5",
                "md5": "a37fce3a8264056628f89c1ae0fb2d49",
                "sha256": "9ca3d42a88499dd5c7cc4f21f383fa3f03033c147b4d5244cd5851737b8d2b6c"
            },
            "downloads": -1,
            "filename": "mkdocs_meta_manager-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a37fce3a8264056628f89c1ae0fb2d49",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.4",
            "size": 3029,
            "upload_time": "2023-03-24T13:26:51",
            "upload_time_iso_8601": "2023-03-24T13:26:51.616072Z",
            "url": "https://files.pythonhosted.org/packages/9e/5e/955d1f2f3879e0eec768bb2fbb330854d950736282d3919f6613a2d2caa5/mkdocs_meta_manager-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ab345c519a28207caafcd133285a98adf60aaecdff43a93d63c9daafb9c60ab",
                "md5": "1c5dd8017c56b7283b6b51fc7fa266b4",
                "sha256": "4bfc30e76aa3a00cbfbe31cfd0e43579eabf556d325bc5a707763cbaa3ba64cf"
            },
            "downloads": -1,
            "filename": "mkdocs-meta-manager-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1c5dd8017c56b7283b6b51fc7fa266b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.4",
            "size": 2524,
            "upload_time": "2023-03-24T13:26:53",
            "upload_time_iso_8601": "2023-03-24T13:26:53.201776Z",
            "url": "https://files.pythonhosted.org/packages/2a/b3/45c519a28207caafcd133285a98adf60aaecdff43a93d63c9daafb9c60ab/mkdocs-meta-manager-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-24 13:26:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "timmeinerzhagen",
    "github_project": "mkdocs-meta-manager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-meta-manager"
}
        
Elapsed time: 0.05144s