# grunt-json-schema-to-markdown

> Grunt tool to convert JSON schema to Markdown documentation

Latest version **0.1.1** (published 2016-05-27) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-05-27 |
| First published | 2016-05-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Edward Woodcock |
| Maintainers | iamfledge |
| Keywords | gruntplugin, json, json schema, jsonschema, markdown, documentation |

## Links

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

## Dependencies (1)

- [json-schema-to-markdown](https://npm.io/package/json-schema-to-markdown.md) ^1.0.1

## 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

- 0.1.1 (latest) — 2016-05-27
- 0.1.0 — 2016-05-27

## README

# grunt-json-schema-to-markdown

> Grunt tool to convert JSON schema to Markdown documentation

[ ![Codeship Status for simplemerchant/grunt-json-schema-to-markdown](https://codeship.com/projects/9fe79e80-0640-0134-8856-6214c662a8db/status?branch=master)](https://codeship.com/projects/154650)

## Overview

This is currently a basic wrapper around the current library: [json-schema-to-markdown](https://www.npmjs.com/package/json-schema-to-markdown)

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-json-schema-to-markdown --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-json-schema-to-markdown');
```

## The "json_schema_to_markdown" task

### Overview
In your project's Gruntfile, add a section named `json_schema_to_markdown` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  markdown_schema: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});
```

### Options

No options currently available for this tool

### Usage Examples

#### Default Options
The output markdown file is specified as a key in the files parameter. Multiple
outputs can be specified. Multiple inputs may be combined into one markdown document.

```js
grunt.initConfig({
  markdown_schema: {
    options: {},
    files: {
      'docs/mySchemas.md': ['schemas/schema1.json', 'schemas/schema2.json'],
    },
  },
});
```

## Release History

#### 0.1.1 - Fix to the README

#### 0.1.0 - Initial release

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