Move MD059 rule to configuration file (#7484)

This commit is contained in:
chonghe
2025-05-20 08:12:46 +08:00
committed by GitHub
parent 50dbfdf612
commit af87135e30
2 changed files with 6 additions and 3 deletions

View File

@@ -25,4 +25,8 @@ MD036: false
# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md # MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md
# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change # Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change
MD040: false MD040: false
# MD059 Link text should be descriptive: https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md
# Set to false because it is too strict
MD059: false

View File

@@ -5,8 +5,7 @@
# Run `make mdlint` from the root of the repository instead. # Run `make mdlint` from the root of the repository instead.
# use markdownlint-cli to check for markdown files # use markdownlint-cli to check for markdown files
# NOTE: we disable MD059 (descriptive-link-text) because it is too strict docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules
docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules --disable MD059
# exit code # exit code
exit_code=$(echo $?) exit_code=$(echo $?)