https://github.com/magicaljellybeans/mkdocs_schema_reader

A mkdocs plugin that scans specified directories and files for JSON Schema files, converts them to markdown and builds them into your documentation.
https://github.com/magicaljellybeans/mkdocs_schema_reader

mkdocs mkdocs-plugins

Last synced: about 2 months ago
JSON representation

A mkdocs plugin that scans specified directories and files for JSON Schema files, converts them to markdown and builds them into your documentation.

• Host: GitHub
• URL: https://github.com/magicaljellybeans/mkdocs_schema_reader
• Owner: magicaljellybeans
• Created: 2020-12-07T16:39:34.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-17T15:03:06.000Z (over 2 years ago)
• Last Synced: 2024-10-14T06:37:44.584Z (3 months ago)
• Topics: mkdocs, mkdocs-plugins
• Language: Python
• Homepage:
• Size: 14.6 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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'