Generate markdown documentation for JSON Schemas

Simple Implementation

npm install json-schema-md-doc

import{JSONSchemaMarkdown}from"json-schema-md-doc";

<scriptsrc="https://brianwendt.github.io/json-schema-md-doc/lib/JSONSchemaMarkdown.js"></script>

// simple schema for the exampleconstcolors_schema={"description":"Choose a color","type":"string","enum":["red","amber","green"]}// create an instance of JSONSchemaMarkdownconstDoccer=newJSONSchemaMarkdown();// load the schemaDoccer.load(colors_schema);// generate the markdownconsole.log(Doccer.generate());

_Choose a color_Type:`string`Enum Values:1._"red"_2._"amber"_3._"green"__Generated with[json-schema-md-doc](https://brianwendt.github.io/json-schema-md-doc/)_

Extendable

classMyDoccerextendsJSONSchemaMarkdown{constructor(){super();this.footer="Thanks for reading the documentation!";}valueBool(bool){if(typeofbool==="string"){returnbool;}else{return(bool) ?"TRUE" :"FALSE";//uppercase instead of true/false}}};

Another example

constDoccer=newJSONSchemaMarkdown();Doccer.indentChar=" ";Doccer.rootChar="";Doccer.pathDivider=".";Doccer.pathForProperties="";Doccer.pathForDefinitions="";Doccer.pathForItems="[*]";Doccer.omitPathDividerForItems=true;Doccer.compact=true;