jsonschema2md icon indicating copy to clipboard operation
jsonschema2md copied to clipboard

Linting issues on generated markdown

Open BenjenJones opened this issue 3 years ago • 3 comments

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

BenjenJones avatar Mar 29 '22 10:03 BenjenJones

MD030 and MD024 seem to be more a question of preference, and won't be addressed.

MD025 could be a reasonable change, but would cause a breaking change as the document structure would be altered substantially.

trieloff avatar Mar 31 '22 11:03 trieloff

problem is, when using the lib would mean to afterwards edit all 40+ files to match the linting. would it be possible to configure the marker spaces?

BenjenJones avatar Mar 31 '22 11:03 BenjenJones

Possibly. I'd review a PR for that.

trieloff avatar Mar 31 '22 11:03 trieloff