json-schema-doc-ts

NOTE: This module supports json-schema.org draft-7. Previous drafts may not generate documentation correctly.

Generate markdown documentation for JSON Schemas

Click here to see the Node example.

If you just need to quickly create markdown from a JSON schema, use the online tool.

Simple Implementation

es6 and later

npm install json-schema-doc-ts

import { JSONSchemaMarkdownDoc } from "json-schema-doc-ts";

// simple schema for the example
const colors_schema = {
    description: "Choose a color",
    type: "string",
    enum: ["red", "amber", "green"],
};

// create an instance of JSONSchemaMarkdownDoc and load the schema
const Doccer = new JSONSchemaMarkdownDoc(colors_schema);
// generate the markdown
console.log(Doccer.generate());

Result

_Choose a color_

Type: `string`

_path: #_

The value is restricted to the following:

1.  _"red"_
2.  _"amber"_
3.  _"green"_

_Generated with [OntoDevelopment/json-schema-doc-ts](https://github.com/OntoDevelopment/json-schema-doc-ts)_

Extendabale

You may easily extend JSONSchemaMarkdownDoc to customize the formatting of your markdown by overriding any method.

import { JSONSchemaMarkdownDoc } from "json-schema-doc-ts";

class MyDoccer extends JSONSchemaMarkdownDoc {
    footer = "Thanks for reading the documentation!";
    valueBool(bool: boolean | string) {
        if (typeof bool === "string") {
            return bool;
        } else {
            return bool ? "TRUE" : "FALSE"; //uppercase instead of true/false
        }
    }
}

Generate documentation in other formats for JSON Schemas

This project may add a JSONSchemaHtmlDoc (JSON Schema to HTML documentation) class in the future. This is a small sample of what that might look like.

import { JSONSchemaDocAbstract } from "json-schema-doc-ts";

class JSONSchemaHtmlDoc extends JSONSchemaDocAbstract {
    writeLine(text: string = "", level: number = 1): this {
        this.response += '<p style="padding-left: ' + level + 'em">' + text + "</p>";
        return this;
    }
    // ...
}

Unit Testing

Unit tests built with vitest. See github.com/OntoDevelopment/json-schema-doc-tests