docusaurus-plugin-generate-schema-docs 1.1.0 → 1.1.1

package/README.md

@@ -0,0 +1,75 @@
+# Docusaurus Plugin: Generate Schema Docs
+
+This Docusaurus v2 plugin generates documentation from JSON schemas. It provides a set of tools to automatically create and validate documentation for your event schemas.
+
+## Features
+
+- **Automatic Documentation Generation**: Generates MDX documentation from your JSON schemas.
+- **Schema Validation**: Validates your schemas against the examples provided within them.
+- **CLI Commands**: Provides CLI commands to generate and validate schema documentation.
+- **Custom Components**: Includes React components to beautifully render your schema documentation.
+
+## Installation
+
+```bash
+npm install --save docusaurus-plugin-generate-schema-docs
+```
+
+## Usage
+
+1.  Configure the plugin in your `docusaurus.config.js`:
+
+    ```javascript
+    // docusaurus.config.js
+
+    module.exports = {
+      // ...
+      plugins: [
+        [
+          'docusaurus-plugin-generate-schema-docs',
+          {
+            // Options if any
+          },
+        ],
+      ],
+      // ...
+    };
+    ```
+
+2.  Place your JSON schemas in the `schemas` directory at the root of your project.
+
+## CLI Commands
+
+### Generate Documentation
+
+To generate the documentation from your schemas, run the following command:
+
+```bash
+npx docusaurus generate schema-docs
+```
+
+This will generate MDX files in the `docs/events` directory.
+
+### Validate Schemas
+
+To validate your schemas, run the following command:
+
+```bash
+npx docusaurus validate-schemas
+```
+
+This will validate the schemas in the `schemas` directory.
+
+## How it Works
+
+The plugin reads your JSON schemas, dereferences any `$ref` properties, and merges `allOf` properties. It then generates an MDX file for each schema, which uses custom React components to render the schema details.
+
+The validation script builds an example from each schema and validates it against the schema itself, ensuring your examples are always in sync with your schemas.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request if you have any ideas or improvements.
+
+## License
+
+This project is licensed under the MIT License.

package/package.json

@@ -1,12 +1,20 @@
 {
   "name": "docusaurus-plugin-generate-schema-docs",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Docusaurus plugin to generate documentation from JSON schemas.",
   "main": "index.js",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benedikt-buchert/tracking_docs.git"
+  },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^15.1.3",
     "fs-extra": "^11.2.0",
     "json-schema-merge-allof": "^0.8.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   }
-}
+}