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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for mkdocs-yaml-schema-plugin-0.2.2.tar.gz
Algorithm Hash digest
SHA256 caccfe9a26958a456196ccee06469d4a55419ba97d9ce949557d8ea38eace954
MD5 70fb55f85c6195d978e5a38e207d9524
BLAKE2b-256 015ebe5a2dbd5a21dac4a003c18b0fed7d2d04d8615ccdf77ab1cad1f3292b75

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