agentleFS
Sign inStart free
Microsoft AzureKnown publisherAzure/azure-sdk-for-rust/.github/skills/lint-markdown/SKILL.md

lint-markdown

Skill887 starsChanged 29 days agoMITView on GitHub

Check and fix formatting and other issues in markdown files using markdownlint-cli2.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check markdown files for common mistakes.

    line 8
  2. Very specific:

    Use the schema matching the installed markdownlint-cli2 version.

    line 21
  3. Distinctive:

    Run the check command again.

    line 42
  4. Very specific:

    Use absolute main links, such as the core README (tree/main for directories), including for new files not yet on main.

    line 46

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Markdown linting

Check markdown files for common mistakes.

Installation and usage

Find the nearest package.json in the current directory or an ancestor through the repository root that lists markdownlint-cli2 in devDependencies. Run npm ci from that directory, then run npx markdownlint-cli2 <command> from the current directory.

Configuration

Configuration is in the repository root .markdownlint-cli2.yaml.

Use the schema matching the installed markdownlint-cli2 version. Nest markdownlint rules under config and use friendly names such as line-length instead of MD013.

Check Markdown

Lint an explicit list of modified markdown files:

npx markdownlint-cli2 --no-globs <files...>

Fix issues

Fix supported issues in an explicit list of files:

npx markdownlint-cli2 --no-globs --fix <files...>

Testing

Run the check command again. Report any remaining issues.

Links

Use absolute main links, such as the core README (tree/main for directories), including for new files not yet on main.

Markdown linting does not validate links. From the repository root, run in PowerShell:

./eng/common/scripts/Verify-Links.ps1 -urls @('<file>', '<file>') -rootUrl "file://$PWD/" -recursive:$false -ignoreLinksFile "$PWD/eng/ignore-links.txt" -checkLinkGuidance:$true -localBuildRepoName 'Azure/azure-sdk-for-rust' -localBuildRepoPath "$PWD"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free