adobe / adobe/jsonschema2md

Linting issues on generated markdown

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

Description

### 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 top level headings in the same document [Context: "# Some Title"]
* MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### some title"]

for the duplicate headings, maybe they need to be prefixed with the current scope, means the parent heading

Contributor guide

Open the contributing guide

Research direction

Start by locating the code that generates the markdown documents and run markdownlint on representative output. Check the reported list-marker spacing and heading rules, then verify that generated markdown completes without MD030, MD025, or MD024 errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown
Domain
documentation
Issue type
Bug
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.