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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for mkdocs-yaml-schema-plugin-0.2.1.tar.gz
Algorithm Hash digest
SHA256 daccca479d8e9d7b5a0bf72e1db9b4f80d734cd9afb377ec462badc7f9267fa2
MD5 52a2eb00460d65e0e261763d51f0acd7
BLAKE2b-256 13fe0c87c7d70721c43aaa88b5779bd73caae35090761ad21067cd453a797e27

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