diff --git a/book/.markdownlint.yml b/book/.markdownlint.yml index 4f7d113364..a40a2f5dbd 100644 --- a/book/.markdownlint.yml +++ b/book/.markdownlint.yml @@ -25,4 +25,8 @@ MD036: false # 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 -MD040: false \ No newline at end of file +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 diff --git a/scripts/mdlint.sh b/scripts/mdlint.sh index abb545ad2f..55d8d1f969 100755 --- a/scripts/mdlint.sh +++ b/scripts/mdlint.sh @@ -5,8 +5,7 @@ # Run `make mdlint` from the root of the repository instead. # 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 --disable MD059 +docker run --rm -v ./book:/workdir ghcr.io/igorshubovych/markdownlint-cli:latest '**/*.md' --ignore node_modules # exit code exit_code=$(echo $?)