npmpackage.info

Gathering detailed insights and metrics for json-schema-to-markdown

Other packages similar to json-schema-to-markdown

json-schema-to-markdown-table

0.4.0

Convert JSON schema to a markdown table

@julian_cataldo/remark-lint-frontmatter-schema

3.7.6

!!!⚠️ MOVED to → `remark-lint-frontmatter-schema` ⚠️!!! — Validate Markdown frontmatter YAML against an associated JSON schema — remark-lint rule plugin

@justmoon/json-schema-to-markdown

1.1.0

Convert JSON schema to a markdown table

@loopstack/markdown-parser

1.1.2

A markdown parser that extracts structured data according to JSON schemas

Gathering detailed insights and metrics for json-schema-to-markdown

json-schema-to-markdown - 1.1.1 | npmpackage.info

json-schema-to-markdown

Turn a JSON Schema into a markdown file.

1.1.1

NOASSERTION

JavaScript

Installations

npm install json-schema-to-markdown

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.11.4

NPM Version

6.9.0 Pull Requests

Open

3

Total

12

Closed

5

Merged

4

Issues

Open

4

Total

8

Closed

4

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

saibotsivad

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

30 Stars

30 Commits

25 Forks

4 Watchers

2 Branches

5 Contributors

Updated on Jun 25, 2024

Maintainers

View All 5 Contributors

Package Meta Information

Latest Version

1.1.1

Package Id

json-schema-to-markdown@1.1.1

Size

7.06 kB

NPM Version

6.9.0

Node Version

8.11.4

Published on

Jun 26, 2019

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

commitizen cz-conventional-changelog is-my-json-valid tape

json-schema-to-markdown

This module turns a JSON Schema into a human-readable markdown file.

This module does not implement anywhere near the full RFC specs. If you have bits of the RFC that you'd like implemented, let me know and I'll try to add them in a timely manner. Pull requests are also very welcome.

using

Install the normal way: npm install json-schema-to-markdown

Use it like this:

1var parse = require('json-schema-to-markdown')
2var schema = // An object that is a valid JSON Schema
3var markdown = parse(schema)

There are plenty of examples in the test folder, but a very simple example would be as follows:

For a JSON file like this:

1{
2	"$schema": "http://json-schema.org/draft-04/schema#",
3	"title": "Example Schema",
4	"description": "This schema is awesome.",
5	"type": "object",
6	"properties": {
7		"price": {
8			"description": "Cost of the product.",
9			"type": "number"
10		}
11	}
12}

The output would be:

1# Example Schema
2
3This schema is awesome.
4
5The schema defines the following properties:
6
7## `price` (number)
8
9Cost of the product.

license

Published and released under the VOL.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More