Skip to main content

MkDocs Plugin to parse yaml schemas.

Project description

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:

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#

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_yaml_schema_plugin-0.3.0.tar.gz (59.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_yaml_schema_plugin-0.3.0-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_yaml_schema_plugin-0.3.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs_yaml_schema_plugin-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f3a982adf96863e7651bb1d3b9637061a6e961f4a86f692ffba515f1289ffa96
MD5 ce4afe08ee9d52a35118519180e1b3ca
BLAKE2b-256 d5d9df26482d4d1a65bdc47b6aac58d0c556cfb7512f22d833edea08bbf9e747

See more details on using hashes here.

File details

Details for the file mkdocs_yaml_schema_plugin-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_yaml_schema_plugin-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 202b046e3528fa1b718255d3990535d40267c3016f2b8fa628463c870ebf5b7c
MD5 3d10c6645ac56feaf90d3362aa53abce
BLAKE2b-256 8e9da92020438bd2c2eaf180ad344ca88834f44d819459fd84af99b25e3505f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page