adobe / adobe/jsonschema2md

No way to stop the creation of .md files for properties after v3

Open
#496 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description

I only want to create a .md folder for each .schema.json file that exists. I don't want a file for each individual file

I also don't want to create numerated files for files with the same prefixes
e.g
foo.bar.schema.json
foo.bar-2.schema.json

will create
foo-1.md
foo-2.md

as well as separate files for all the individual properties of the schema.

I want a way to create

foo.bar.md
foo.bar-2.md

with no other files for their definitions/properties

If I have 100+ json schema I do not want 400+ files representing all the individual properties, I want a 1-1 schema to .md ratio

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the post-v3 generation behavior described in the issue with schemas containing nested properties and shared prefixes. Trace the repository's schema-to-Markdown generation entry point to find where property files and numbered filenames are created. Done means supporting a one-schema-to-one-Markdown option that produces only the requested schema-level files.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.