mkdocs-yaml-schema-plugin

Name	mkdocs-yaml-schema-plugin JSON
Version	0.2.3 JSON
	download
home_page	https://github.com/smeds/mkdocs-yaml-schema-plugin
Summary	MkDocs Plugin to parse yaml schemas.
upload_time	2023-05-04 12:41:25
maintainer
docs_url	None
author	Patrik Smeds
requires_python	>=3.8, <4
license	MIT license
keywords	mkdocs plugin yaml schema
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # MkDocs Yaml Schema Plugin

MkDocs Plugin to parse yaml schema files.

To use this plugin, install it with pip in the same environment as MkDocs:

```
pip install MkDocsYamlSchemaPlugin
```

Then add the following entry to the MkDocs config file:

```yml
plugins:
- yaml-schema:
    yaml_files: 
      - file: "workflow/schemas/config.schema.yaml"
        tag: "CONFIGSCHEMA"
      - file: "workflow/schemas/resources.schema.yaml"
        tag: "RESOURCESSCHEMA"
```

In your target file, add a tag to be replaced
```
#RESOURCESSCHEMA#
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/smeds/mkdocs-yaml-schema-plugin",
    "name": "mkdocs-yaml-schema-plugin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8, <4",
    "maintainer_email": "",
    "keywords": "mkdocs,plugin,yaml,schema",
    "author": "Patrik Smeds",
    "author_email": "patrik.smeds@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b2/69/deb8ee2d4afaa52a35c31158092196ff0931fe684bb60edc6ada998751f1/mkdocs-yaml-schema-plugin-0.2.3.tar.gz",
    "platform": null,
    "description": "# MkDocs Yaml Schema Plugin\n\nMkDocs Plugin to parse yaml schema files.\n\nTo use this plugin, install it with pip in the same environment as MkDocs:\n\n```\npip install MkDocsYamlSchemaPlugin\n```\n\nThen add the following entry to the MkDocs config file:\n\n```yml\nplugins:\n- yaml-schema:\n    yaml_files: \n      - file: \"workflow/schemas/config.schema.yaml\"\n        tag: \"CONFIGSCHEMA\"\n      - file: \"workflow/schemas/resources.schema.yaml\"\n        tag: \"RESOURCESSCHEMA\"\n```\n\nIn your target file, add a tag to be replaced\n```\n#RESOURCESSCHEMA#\n```\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "MkDocs Plugin to parse yaml schemas.",
    "version": "0.2.3",
    "project_urls": {
        "Homepage": "https://github.com/smeds/mkdocs-yaml-schema-plugin"
    },
    "split_keywords": [
        "mkdocs",
        "plugin",
        "yaml",
        "schema"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b269deb8ee2d4afaa52a35c31158092196ff0931fe684bb60edc6ada998751f1",
                "md5": "bd994f69842f3458326f064184c780a0",
                "sha256": "6b77c7be33f6a46ccd1dc12af86879ba128d976e581e8ab4eef98c790c51c2cd"
            },
            "downloads": -1,
            "filename": "mkdocs-yaml-schema-plugin-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "bd994f69842f3458326f064184c780a0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8, <4",
            "size": 33802,
            "upload_time": "2023-05-04T12:41:25",
            "upload_time_iso_8601": "2023-05-04T12:41:25.831310Z",
            "url": "https://files.pythonhosted.org/packages/b2/69/deb8ee2d4afaa52a35c31158092196ff0931fe684bb60edc6ada998751f1/mkdocs-yaml-schema-plugin-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-04 12:41:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "smeds",
    "github_project": "mkdocs-yaml-schema-plugin",
    "github_not_found": true,
    "lcname": "mkdocs-yaml-schema-plugin"
}