jsonschema2md icon indicating copy to clipboard operation
jsonschema2md copied to clipboard

Creating a single md file with all nested properties/objects

Open 777arc opened this issue 2 years ago • 1 comments

The SigMF Project https://github.com/sigmf/SigMF currently has both a manually-written specifications document written in markdown, and an accompanying JSON schema, and we are looking into how we can auto-generate the markdown so that everything can "live" within a single file. I've been playing with jsonschema2md and it seems great, but it generates a md file per layer so we end up with dozens, and ideally we would have it generate 1 big md file with internal links to subsections. I was wondering if there is any way to do this with jsonschema2md. Our latest json schema can be found here https://github.com/Nepomuceno/SigMF/blob/spec_adition/spec/1.0.0/schema-meta.json

777arc avatar Aug 21 '23 18:08 777arc

We have the same issue. We have a generic Helm Chart accompanied by a values.schema.json file and if we use this tool we end up with approx. 90~ files.

Since there is no support for just generating one file and there is no support for generating nested pages in md, we have to do a lot of manual processing before we can add it to our documentation.

pareion avatar Sep 13 '24 09:09 pareion