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:
plugins:
- search
- schema_reader
Then, specify folders and files that you want to include in mkdocs.yml relative to it's location, like so:
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
pluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry 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'
Metadata
Release files for mkdocs-schema-reader 0.11.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_schema_reader-0.11.1.tar.gz | 2.7 kB | Without provenance | Details for mkdocs_schema_reader-0.11.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_schema_reader-0.11.1-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_schema_reader-0.11.1-py3-none-any.whl |
Total release size: 6.2 kB
Release files / mkdocs_schema_reader-0.11.1.tar.gz
| Download URL | mkdocs_schema_reader-0.11.1.tar.gz |
|---|---|
| Size | 2.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
65215f75ad5a3aefafc5d2f768f298a8075cce45991c185e1603ebdbf181786b
|
|
BLAKE2b-256 checksum How to use checksums |
efffb961f2c812ab9efb4b899237a4a5e534a35379c34c4cd31df058d78e4282
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.6.1 requests/2.19.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.3
|
Release files / mkdocs_schema_reader-0.11.1-py3-none-any.whl
| Download URL | mkdocs_schema_reader-0.11.1-py3-none-any.whl |
|---|---|
| Size | 3.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fde138eabf855a65c1d58d16614b37757e5eba1de7b25753fc619d88f62a923c
|
|
BLAKE2b-256 checksum How to use checksums |
991304abff6854ff61655be4dbca293c47703a813097ebc00f14519faef4d192
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.6.1 requests/2.19.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.3
|
Security for mkdocs-schema-reader 0.11.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.