# Lint Markdown

> Lint 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.

- Skill name: `lint-markdown`
- Category: [Documents](https://www.openparable.com/skill/documents/1)
- Source: https://github.com/Azure/azure-sdk-for-rust/blob/HEAD/.github/skills/lint-markdown/SKILL.md
- Repository: Azure/azure-sdk-for-rust (881 GitHub stars when collected)

## SKILL.md

# 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:

```bash
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.

---

Source: https://www.openparable.com/skill/documents/lint-markdown (OpenParable). Cite the canonical URL above.
