Skip to content

chore: use find for md discovery and relax link rules #8488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gjermundgaraba merged 1 commit into from
Jun 6, 2025
Merged

chore: use find for md discovery and relax link rules #8488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,11 @@ check-docs-links:
'./docs/docs'

lint-docs:
@command -v markdownlint-cli2 >/dev/null 2>&1 || { echo "ERROR: markdownlint-cli2 is not installed (https://github.com/DavidAnson/markdownlint-cli2#install)" >&2; exit 1; }
@command -v markdownlint-cli2 >/dev/null 2>&1 || { \
echo "ERROR: markdownlint-cli2 is not installed" >&2; exit 1; \
}
@echo "Linting documentation..."
@markdownlint-cli2 ./docs/docs/**/*.md
@find docs/docs -type f -name '*.md' | xargs markdownlint-cli2

.PHONY: build-docs serve-docs tag-docs-version

Expand Down
3 changes: 2 additions & 1 deletion docs/.markdownlint.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,6 @@
}, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md049---emphasis-style-should-be-consistent
"MD050": {
"style": "asterisk"
} // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md050---strong-style-should-be-consistent
}, // https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md050---strong-style-should-be-consistent
"MD059": false, //https://github.com/DavidAnson/markdownlint/blob/main/doc/md059.md---undescriptive link names
}
Loading