jsonschema2md icon indicating copy to clipboard operation
jsonschema2md copied to clipboard

Convert Complex JSON Schemas into Markdown Documentation

Results 55 jsonschema2md issues
Sort by recently updated
recently updated
newest added

This issue lists Renovate updates and detected dependencies. Read the [Dependency Dashboard](https://docs.renovatebot.com/key-concepts/dashboard/) docs to learn more.[View this repository on the Mend.io Web Portal](https://developer.mend.io/github/adobe/jsonschema2md). ## Deprecations / Replacements > [!WARNING] These...

For some parts you use already js-yaml, why not add an option to parse yaml files instead json? The yaml files could then internally be transformed to json and parsed...

### Expected Behaviour Converts JSON schema to MD. ### Actual Behaviour The following error is thrown: ``` TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received undefined at...

bug

### Expected Behaviour Running markdownlint on generated markdowns should not throw errors ### Actual Behaviour Generated Errors: * MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 3] * MD025/single-title/single-h1 Multiple...

enhancement

The CLI is cumbersome. It requires placing the schema file in a directory with a unique extension and then outputting to a directory. I just want to take a single...

### Expected Behaviour Inherited nodes within ``allOf`` clauses would be displayed within the markdown. ### Actual Behaviour Nodes inherited through ``allOf`` clauses from common definitions are not correctly linked within...

bug

### Expected Behaviour Type of field only reported once. And type section is compact in the generated output. Preferable a table format always for the required, type, defined location and...

## What did you do Convert the if-then example from JSON Schema doc at https://json-schema.org/understanding-json-schema/reference/conditionals.html using filename `test.json`. Example replicated below ## What did you expect to happen The if-then...

I don't want to have to add a title for every object so I don't see "Untitled object" everywhere. Its really redundant because all my object names are what I...

enhancement

### Expected Behaviour No vulnerabilities found ### Actual Behaviour Security vulnerabilities are found with: - set-value - ansi-html - glob-parent ### Reproduce Scenario (including but not limited to) #### Steps...