# json-schema-to-markdown

> Turn a JSON Schema into a markdown file.

Latest version **1.1.1** (published 2019-06-26) · VOL license · 0 weekly downloads

## Install

```sh
npm install json-schema-to-markdown
pnpm add json-schema-to-markdown
yarn add json-schema-to-markdown
bun add json-schema-to-markdown
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-06-26 |
| First published | 2015-07-20 |
| Weekly downloads | 0 |
| License | VOL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | saibotsivad |
| Maintainers | saibotsivad |
| Keywords | json-schema, markdown |

## Links

- npm: https://www.npmjs.com/package/json-schema-to-markdown
- Repository: https://github.com/saibotsivad/json-schema-to-markdown
- Issues: https://github.com/saibotsivad/json-schema-to-markdown/issues
- npm.io page: https://npm.io/package/json-schema-to-markdown

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.1 (latest) — 2019-06-26
- 1.1.0 — 2019-02-16
- 1.0.3 — 2016-08-07
- 1.0.2 — 2016-08-06
- 1.0.1 — 2015-07-20
- 1.0.0 — 2015-07-20

## README

# json-schema-to-markdown

This module turns a [JSON Schema](http://json-schema.org/) 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:

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

There are plenty of examples in the [test folder](./test), but a very
simple example would be as follows:

For a JSON file like this:

```json
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "Example Schema",
	"description": "This schema is awesome.",
	"type": "object",
	"properties": {
		"price": {
			"description": "Cost of the product.",
			"type": "number"
		}
	}
}
```

The output would be:

```markdown
# Example Schema

This schema is awesome.

The schema defines the following properties:

## `price` (number)

Cost of the product.
```

# license

Published and released under the [VOL](http://veryopenlicense.com).

---
_Source: https://npm.io/package/json-schema-to-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._