Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creating a single md file with all nested properties/objects #531

Open
777arc opened this issue Aug 21, 2023 · 1 comment
Open

Creating a single md file with all nested properties/objects #531

777arc opened this issue Aug 21, 2023 · 1 comment

Comments

@777arc
Copy link

777arc commented Aug 21, 2023

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

@pareion
Copy link

pareion commented Sep 13, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants