Skip to content

Commit af87135

Browse files
authored
Move MD059 rule to configuration file (#7484)
1 parent 50dbfdf commit af87135

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

book/.markdownlint.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,8 @@ MD036: false
2525

2626
# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md
2727
# 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
28-
MD040: false
28+
MD040: false
29+
30+
# MD059 Link text should be descriptive: https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md
31+
# Set to false because it is too strict
32+
MD059: false

scripts/mdlint.sh

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
# Run `make mdlint` from the root of the repository instead.
66

77
# use markdownlint-cli to check for markdown files
8-
# NOTE: we disable MD059 (descriptive-link-text) because it is too strict
9-
docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules --disable MD059
8+
docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules
109

1110
# exit code
1211
exit_code=$(echo $?)

0 commit comments

Comments
 (0)