{"id":48326,"library":"jsonschema2mk","title":"jsonschema2mk","description":"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.","status":"active","version":"2.1.4","language":"javascript","source_language":"en","source_url":"https://github.com/simonwalz/jsonschema2mk","tags":["javascript"],"install":[{"cmd":"npm install jsonschema2mk","lang":"bash","label":"npm"},{"cmd":"yarn add jsonschema2mk","lang":"bash","label":"yarn"},{"cmd":"pnpm add jsonschema2mk","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Package is ESM-only; CommonJS require will fail. Use default import.","wrong":"const jsonschema2mk = require('jsonschema2mk')","symbol":"jsonschema2mk","correct":"import jsonschema2mk from 'jsonschema2mk'"},{"note":"Schema file must be specified with --schema option, not positional argument.","wrong":"npx jsonschema2mk schema.json >DOC.md","symbol":"cli","correct":"npx jsonschema2mk --schema schema.json >DOC.md"},{"note":"Extensions are loaded via --extension flag, not a separate option.","wrong":"npx jsonschema2mk --table-format-2","symbol":"Extensions","correct":"npx jsonschema2mk --extension table-format-2"}],"quickstart":{"code":"npx jsonschema2mk --schema schema.json >DOC.md","lang":"typescript","description":"Generate markdown documentation from a JSON Schema file using CLI. Output is redirected to DOC.md."},"warnings":[{"fix":"Use import syntax or npx CLI.","message":"package is ESM-only since v2; require() will not work.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Add >output.md to CLI command.","message":"Output is written to stdout; must redirect to file.","severity":"gotcha","affected_versions":"*"},{"fix":"Always specify --schema path/to/schema.json","message":"--schema option is required; missing will look for schema.json in current directory.","severity":"gotcha","affected_versions":"*"},{"fix":"Use --extension table-format-2","message":"Default table format shows combined name/title column; prefer --extension table-format-2 for separate columns.","severity":"deprecated","affected_versions":"*"}],"env_vars":null,"search_vec":"'2.1.4':10 'activ':17 'allof/oneof/anyof':38 'array':37 'attribut':31 'basic':30 'boolean':34 'cli':59 'cli-first':58 'custom':50 'develop':18 'differenti':43 'document':4 'exampl':54 'extens':44 'featur':28 'first':60 'format':52 'front':56 'generat':2 'github':20 'if/then/else':39 'includ':29 'javascript':65 'json':6,26 'jsonschema2mk':1 'latest':13 'markdown':3 'matter':57 'multipl':41 'npx':63 'null':35 'number':32 'object':36 'partial':46 'plugin':48 'rang':24 'releas':15 'schema':7,27 'simpl':62 'specif':8 'stabl':14 'string':33 'support':21,49 'tabl':51 'type':42 'usag':64 'version':9 'via':45 'wide':23 'yaml':53","created_at":"2026-06-07T16:56:04.378619+00:00","updated_at":"2026-06-07T16:56:04.378619+00:00","problems":[{"fix":"Use dynamic import: await import('jsonschema2mk') or switch to ESM.","cause":"Using CommonJS require() with ESM-only package.","error":"Error [ERR_REQUIRE_ESM]: require() of ES Module not supported."},{"fix":"Provide --schema path/to/schema.json","cause":"Missing --schema option or file not found.","error":"ENOENT: no such file or directory, open 'schema.json'"},{"fix":"Use --extension table-format-2 exactly.","cause":"Typo or incorrect extension name.","error":"Unknown extension: table-format-2"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/simonwalz/jsonschema2mk","github":"https://github.com/simonwalz/jsonschema2mk","docs":null,"changelog":null,"pypi":null,"npm":"jsonschema2mk","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}