From b0b28921e52df28bad797dcd6e84d5ccc2c41e6a Mon Sep 17 00:00:00 2001 From: Pete Stenger Date: Thu, 20 Mar 2025 11:36:57 -0500 Subject: [PATCH] update --- LICENCSE => LICENSE | 0 README.md | 8 +++++--- requirements.txt | 2 +- setup.py | 10 +++++----- 4 files changed, 11 insertions(+), 9 deletions(-) rename LICENCSE => LICENSE (100%) diff --git a/LICENCSE b/LICENSE similarity index 100% rename from LICENCSE rename to LICENSE diff --git a/README.md b/README.md index 4f73e5f..cea05e6 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,14 @@ 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. -**Breaking Change** This version can introduce some breaking change. Markdown output is now wrtie to documentation directory (`${docs_dir/schema}`)instead of `site/schema`. If your documentation was in `site` folder, this will change nothing. Use the new `output` options for control it if needed. +> [!IMPORTANT] +> This fork introduces some breaking change over the original `mkdocs-schema-reader`. Markdown output is now written to the documentation directory (`${docs_dir/schema}`)instead of `site/schema`. If your documentation was in `site` folder, this will change nothing. Use the new `output` options for control it if needed. ## Setup Install the plugin using pip: -`pip install mkdocs-schema-reader` +`pip install mkdocs_schema_reader_2` Activate the plugin in `mkdocs.yml`: ```yaml @@ -29,7 +30,8 @@ plugins: 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. +> [!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]. diff --git a/requirements.txt b/requirements.txt index 4ade5f0..2d9285f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -mkdocs>=1.0.3 +mkdocs>=1.0.4 jsonschema2md>=0.3.0 diff --git a/setup.py b/setup.py index 381022c..438eb7d 100644 --- a/setup.py +++ b/setup.py @@ -5,15 +5,15 @@ long_description = fh.read() setup( - name="mkdocs_schema_reader", + name="mkdocs_schema_reader_2", version="0.12.1", - description="A MkDocs plugin to collate json schema files and convert them into markdown files", + description="A MkDocs plugin to embed json schema files as markdown within your documentation.", long_description=long_description, long_description_content_type="text/markdown", keywords="mkdocs, schema, json, plugin", - url="https://github.com/magicaljellybeans/mkdocs_schema_reader", - author="Tom Robinson", - author_email="tome.robin@gmail.com", + url="https://github.com/mysiki/mkdocs_schema_reader", + author="", + author_email="", license="MIT", python_requires=">=3.6", install_requires=["mkdocs>=1.0.4", "jsonschema2md>=0.3.0"],