{"id":16492698,"url":"https://github.com/jeremyrajan/json-markdown","last_synced_at":"2025-03-21T07:31:49.811Z","repository":{"id":40288332,"uuid":"57563824","full_name":"jeremyrajan/json-markdown","owner":"jeremyrajan","description":"Create Markdown docs for JSON Schema","archived":false,"fork":false,"pushed_at":"2023-01-13T00:06:50.000Z","size":743,"stargazers_count":3,"open_issues_count":23,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-12T14:06:54.618Z","etag":null,"topics":["cli","json","json-markdown","json-schema"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeremyrajan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-01T06:42:24.000Z","updated_at":"2023-08-23T09:24:40.000Z","dependencies_parsed_at":"2023-02-09T13:46:45.898Z","dependency_job_id":null,"html_url":"https://github.com/jeremyrajan/json-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyrajan%2Fjson-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyrajan%2Fjson-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyrajan%2Fjson-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeremyrajan%2Fjson-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeremyrajan","download_url":"https://codeload.github.com/jeremyrajan/json-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221813007,"owners_count":16884740,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","json","json-markdown","json-schema"],"created_at":"2024-10-11T14:06:56.131Z","updated_at":"2024-10-28T09:37:14.468Z","avatar_url":"https://github.com/jeremyrajan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# json-markdown\n\nThis Project is fork of https://github.com/joxoo/jsonschema-md. With added features. Thank you [joxoo](https://github.com/joxoo).\n\n[![Build Status](https://travis-ci.org/jeremyrajan/json-markdown.svg?branch=master)](https://travis-ci.org/jeremyrajan/json-markdown)\n\n## About\njson-markdown is a simple tool to generate documentation for your JSON schema. The lib provides a CLI api and pro-grammatical api for use in your applications.\n\n## Usage\n\n```\nnpm install --save [-g] json-markdown\n```\n\n### CLI\n```\njson-markdown \u003clocation-to-your-file.json\u003e --w=true/false\n```\n\nYou can pass -w=true/false, if you want to write to a file or not. By default its true.\n\nThis will generate the markdown from your schema and create `SCHEMA.md` in the current directory. You can also provide an output file, to which you want to write:\n\n```\njson-markdown \u003clocation-to-your-file.json\u003e \u003coutput-file-location.md\u003e --w=true/false\n```\n\n### API usage.\n```javascript\nconst jsonmarkdown = require('json-markdown');\nconst schemaLoc = './product.json';\nconst outputFile = 'output-file.md'; // if you don't provide an output file, it will create an .md from your schema filename.\n// the third argument defines, if you want to write to file or not. Set it to false, if you dont need to create a markdown yet.\njsonmarkdown.process(schemaLoc, outputFile, true, (err, result) =\u003e {\n  console.log(result);\n});\n\n```\n\nReport issues: https://github.com/jeremyrajan/jsonschema-md/issues\n\nHope it helps, someone :).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremyrajan%2Fjson-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeremyrajan%2Fjson-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeremyrajan%2Fjson-markdown/lists"}