Lint Markdown
Documentslint-markdownLint Markdown is an Agent Skill for documents published in the Azure/azure-sdk-for-rust repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Check and fix formatting and other issues in markdown files using markdownlint-cli2.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/Azure/azure-sdk-for-rust/blob/HEAD/.github/skills/lint-markdown/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/lint-markdown, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Markdown linting
Check markdown files for common mistakes.
Installation and usage
Run npm ci from this skill directory (.github/skills/lint-markdown/) first. Then run commands using npm exec --prefix .github/skills/lint-markdown -- markdownlint-cli2 {command} from the repository root.
Configuration
Configuration is in .markdownlint-cli2.yaml files. The root configuration is at the repository root.
For markdownlint rules configuration, nest it under the config property following the markdownlint schema at https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json. Use friendly rule names (e.g., line-length) instead of codes (e.g., MD013).
Check Markdown
Run npm exec --prefix .github/skills/lint-markdown -- markdownlint-cli2 from the repository root with a list of modified markdown files to lint.
Fix issues
Run with the --fix flag with a list of modified markdown files to automatically fix supported issues:
npm exec --prefix .github/skills/lint-markdown -- markdownlint-cli2 --fix
Testing
Run the same lint command again to verify all issues are fixed. There should be no errors reported.