adobe / adobe/jsonschema2md

Support yaml schema files

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

Description

We write all out schemas in YAML and currently need an extra step to convert all the files to JSON before calling `jsonschema2md`.

It would be great if an input format could be passed as a flag (or even if setting the extension to `yaml` or `yml` automatically read files as YAML).

Contributor guide

Open the contributing guide

Research direction

Start by locating jsonschema2md's input parsing and command-line entry point, since the issue currently requires converting YAML before calling the tool. Check how input files are loaded and where flags or extensions are handled. Done means YAML schema files can be passed directly, with the existing Markdown output preserved.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.