json-schema-static-docs

0.25.0 • Public • Published

Json Schema Static Docs

npm version CircleCI

Description

Generates static documentation for humans based on the contents of JSON schema files (yml or json).

Support for JSON schema specification versions

Currently supports schema specified using the following specification versions: draft-06, draft-07 and draft-2019-09.

For complete documentation, including examples and supported keywords, see tomcollins.github.io/json-schema-static-docs.

Installation

npm install json-schema-static-docs

Usage

See the docs for more details.

const JsonSchemaStaticDocs = require("json-schema-static-docs");

(async () => {
  let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({
    inputPath: "./schema",
    outputPath: "./docs",
    ajvOptions: {
      allowUnionTypes: true,
    },
  });
  await jsonSchemaStaticDocs.generate();
  console.log("Documents generated.");
})();

Readme

Keywords

none

Package Sidebar

Install

npm i json-schema-static-docs

Weekly Downloads

304

Version

0.25.0

License

GPL-3.0-only

Unpacked Size

175 kB

Total Files

65

Last publish

Collaborators

  • tomcollinsuk