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.2.0.tar.gz (33.8 kB view details)

Uploaded Source

File details

Details for the file mkdocs-yaml-schema-plugin-0.2.0.tar.gz.

File metadata

File hashes

Hashes for mkdocs-yaml-schema-plugin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 17eb7eb08fa2e21b12466ba72a1be763e58532f888a9a2b158f34f3dc52a3176
MD5 001cebd750a6ebf17424a7224812c482
BLAKE2b-256 78da8419759a2781ce8d1314fb0c2b6b747182531a702cb37ae1fc7bc6bb2328

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