Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Linting issues on generated markdown #408

Open
BenjenJones opened this issue Mar 29, 2022 · 3 comments
Open

Linting issues on generated markdown #408

BenjenJones opened this issue Mar 29, 2022 · 3 comments

Comments

@BenjenJones
Copy link

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

@trieloff
Copy link
Collaborator

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.

@BenjenJones
Copy link
Author

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?

@trieloff
Copy link
Collaborator

Possibly. I'd review a PR for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants