Update markdownlint configuration for list indentation #222
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The configuration for markdownlint has been updated to include setting the indentation of list item to 4 spaces ("MD007"). This is intended to ensure the correct formatting for markdown documents in MkDocs.
References:
- https://github.com/DavidAnson/markdownlint/blob/main/doc/md007.md
- https://python-markdown.github.io/#differences
Signed-off-by: Frank Brückner <dev@froschdesignstudio.de>
Ocramius
approved these changes
Mar 8, 2024
|
Ah, just a note: this obviously broke a hell of pipelines downstream. @froschdesign is |
|
It is expected. Strictly 4 due to mkdocs using original markdown, not commonmark, with some strict interpretations of said spec. See: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The configuration for markdownlint has been updated to include setting the indentation of list item to 4 spaces ("MD007"). This is intended to ensure the correct formatting for markdown documents in MkDocs.
References: