Add config file for markdownlint#903
Merged
mhucka merged 7 commits intoquantumlib:mainfrom Apr 28, 2025
Merged
Conversation
This adds a configuration file for a Markdown file linter:(https://github.com/igorshubovych/markdownlint-cli). It follows Google Markdown style as closely as possible in a way compatible with GitHub-flavored Markdown, with the exception of the line length, which is set to 120 in order to match the value in `.clang-format`.
Strilanc
approved these changes
Apr 5, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds a configuration file for a Markdown file linter:(https://github.com/igorshubovych/markdownlint-cli). It follows Google Markdown style as closely as possible in a way compatible with GitHub-flavored Markdown, with the exception of the line length, which is set to 120 in order to match the value in
.clang-format.This is useful even in the absence of additional scripts to run the linter on demand or as part of other checks, because some text editors can automatically detect and use the configuration to provide hints to users editing
.mdfiles in the project. In addition, users can runmarkdownlintby hand.