jsonschema-markdown

1.0.0 • Public • Published

JSON-Schema Markdown

A quick hack at generating Markdown from JSON-Schema.

Usage

var Parser = require('jsonschema-markdown');

var generator = new Parser(schema, options);

var markdown = generator.generateMarkdown();

Or

var Parser = require('jsonschema-markdown');

var generator = new Parser(schema, options);

generator.addSchema(schema2); // add a linked schema

var markdown = generator.generateMarkdown();

Options:

  • depth - depth of markdown header, defaults to 2
  • links - whether to try to make links for types, defaults to true

Package Sidebar

Install

npm i jsonschema-markdown

Weekly Downloads

2

Version

1.0.0

License

MIT

Last publish

Collaborators

  • jerrysievert