Skip to content
Back to skills

Lint Docs

ASecurity

Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.

  • 86 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added June 5, 2026
ai-agentsshellbashgitdocumentation

Security analysis

A100/100

Scanned June 5, 2026

npx -y skills add MuhammadUsmanGM/claude-code-best-practices --skill lint-docs --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Lint Docs?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Lint Docs
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/muhammadusmangm-lint-docs/badge)](https://www.skillsdirectory.com/skills/muhammadusmangm-lint-docs)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: lint-docs
description: Run this repo's documentation and shell quality gates (shellcheck, markdownlint, lint-claude-md) the same way CI runs them. Invoke before opening a PR, or when the user asks to lint, validate, or pre-flight the docs.
allowed-tools: Bash(shellcheck:*), Bash(markdownlint:*), Bash(bash tools/lint-claude-md.sh:*), Bash(find:*), Bash(git status:*), Read
---

# Lint Docs

Run the same three checks CI runs and report pass/fail per check.

## Steps

1. **shellcheck** — find every `.sh` under the repo and run `shellcheck` on it.
   ```bash
   find . -name '*.sh' -not -path './.git/*' -print0 | xargs -0 shellcheck
   ```
2. **markdownlint** — run `markdownlint` on `README.md`, `CONTRIBUTING.md`,
   `CHANGELOG.md`, and everything under `guides/`, `examples/`, `plugins/`,
   `tools/hooks/`. Use `.markdownlint.json` at repo root.
3. **lint-claude-md** — run `bash tools/lint-claude-md.sh` against every
   `examples/claude-md-*.md` template and the repo's own `CLAUDE.md`.

## Output

Print a single summary table, one row per check:

| Check | Status | Details |
|-------|--------|---------|

If any check fails, print the first 20 lines of its output below the table and
stop. Do not try to auto-fix unless the user asks.

## Rules

- If `shellcheck` or `markdownlint` isn't installed, say so and skip that
  check — don't silently pass.
- Do not modify files. This skill is diagnostic only.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.