Metadata-Version: 2.1
Name: mkdocs-schema-reader
Version: 0.11.1
Summary: A MkDocs plugin to collate json schema files and convert them into markdown files
Home-page: https://github.com/magicaljellybeans/mkdocs_schema_reader
Author: Tom Robinson
Author-email: tome.robin@gmail.com
License: MIT
Keywords: mkdocs,schema,json,plugin
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# mkdocs schema reader plugin 

This is a plugin that scans the specified directories and files for JSON Schema files, converts them to markdown and builds them into your documentation.

## Setup

Install the plugin using pip:

`pip install mkdocs-schema-reader`

Activate the plugin in `mkdocs.yml`:
```yaml
plugins:
  - search
  - schema_reader
```

Then, specify folders and files that you want to include in `mkdocs.yml` relative to it's location, like so:
```yaml
plugins:
  - search
  - schema_reader:
      include: 
        - "../JSONSchema/"
        - "../example/directory/schema.json"
```

Specified directories will be scanned for schema json files, so consider specifying individual files for expansive directories.

> **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.

More information about plugins in the [MkDocs documentation][mkdocs-plugins].

## Usage

Just activate the plugin, specify directories and files in the manner shown above, and it will operate when normal mkdocs commands are used like `mkdocs serve'


