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

Uploaded Source

Supported by

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