jsonschema2mk

library2.1.4jsnpmunverified

Generate Markdown documentation from JSON Schema specifications. Version 2.1.4 is the latest stable release, with active development on GitHub. Supports a wide range of JSON Schema features including basic attributes, number, string, boolean, null, object, array, allOf/oneOf/anyOf, if/then/else, and multiple types. Differentiators: extensible via partials and plugins, supports custom table formats, YAML examples, and front matter. CLI-first with simple npx usage.

devops

npm install jsonschema2mk

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · JSONSCHEMA2MK

jsonschema2mk

devopsjavascriptv2.1.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

jsonschema2mk

✓ import jsonschema2mk from 'jsonschema2mk'

✗ const jsonschema2mk = require('jsonschema2mk')

Package is ESM-only; CommonJS require will fail. Use default import.

cli

✓ npx jsonschema2mk --schema schema.json >DOC.md

✗ npx jsonschema2mk schema.json >DOC.md

Schema file must be specified with --schema option, not positional argument.

Extensions

✓ npx jsonschema2mk --extension table-format-2

✗ npx jsonschema2mk --table-format-2

Extensions are loaded via --extension flag, not a separate option.

Generate markdown documentation from a JSON Schema file using CLI. Output is redirected to DOC.md.

npx jsonschema2mk --schema schema.json >DOC.md

Debug

Known issues

breakingpackage is ESM-only since v2; require() will not work.

fix

Use import syntax or npx CLI.

affects: >=2.0.0

gotchaOutput is written to stdout; must redirect to file.

fix

Add >output.md to CLI command.

affects: *

gotcha--schema option is required; missing will look for schema.json in current directory.

fix

Always specify --schema path/to/schema.json

affects: *

deprecatedDefault table format shows combined name/title column; prefer --extension table-format-2 for separate columns.

fix

Use --extension table-format-2

affects: *

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported.

Using CommonJS require() with ESM-only package.

fix

Use dynamic import: await import('jsonschema2mk') or switch to ESM.

ENOENT: no such file or directory, open 'schema.json'

Missing --schema option or file not found.

fix

Provide --schema path/to/schema.json

Unknown extension: table-format-2

Typo or incorrect extension name.

fix

Use --extension table-format-2 exactly.

Upgrade

Version history

2.1.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

9 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/simonwalz/jsonschema2mk ↗

packagejsonschema2mk ↗

homepagehttps://github.com/simonwalz/jsonschema2mk ↗