This directory contains configuration files for the various documentation validation tools used in our workflow.
.markdownlint.yml: Configuration for markdownlint rulesmarkdown-link-check.json: Configuration for markdown-link-check tool
These configuration files are used by MegaLinter's documentation flavor. MegaLinter provides a standardized way to run various linters with consistent configuration and reporting.
The .markdownlint.yml file controls the rules for markdown linting, including:
- Heading structure and formatting
- List formatting and consistency
- Permitted HTML elements
- Line length requirements
- Code block formatting
The markdown-link-check.json file configures link validation:
- URL patterns to ignore (anchors, mailto, etc.)
- URL replacement patterns
- Timeout and retry settings
- Valid status codes
To run these tools locally:
# Run markdown linting
make lint/markdown
# Run full documentation validation (including links)
make lint/docsWhen modifying configuration files:
- Test changes locally first
- Document any significant changes in the PR
- Consider impacts on existing documentation
- Run the test script to validate integration:
.github/docs/testing/test-megalinter.sh