agentleFS
Sign inStart free
mattmirelesmattmireles/gemma-tuner-multimodal/.claude/skills/markdown/SKILL.md

markdown

Skill1.5k starsChanged 4 days agoMITView on GitHub

Write or repair repo markdown files. Use when the task is editing README files, guides, plans, notes, or markdown lint failures. Apply the repo's markdown rules, preserve the right template or document structure, and keep prose tight. Do not use for inline code comments or code changes that only happen to touch markdown strings.

We split this skill into the rules it gives an agent

6 rules. 0 are common, 6 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 12 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill to keep repo markdown clean, consistent, and easy to maintain.

    line 10
  2. Distinctive:

    Read references/index.md first.

    line 26
  3. Distinctive:

    Use the canonical template when the document family has one.

    line 32
  4. Distinctive:

    no unnecessary inline HTML

    line 37
  5. Distinctive:

    Keep prose lean. Prefer one canonical explanation over duplicated text across several files.

    line 41
  6. Distinctive:

    If the task is markdown-focused or touches several markdown files, run a markdown lint pass before stopping when repo tooling is available.

    line 43

“Common” is measured: kept by at least 6 in 10 of the 12 edited versions of this file we could read. “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

Purpose

Use this skill to keep repo markdown clean, consistent, and easy to maintain.

Use When

  • Writing or revising markdown docs.
  • Fixing markdown lint failures.
  • Editing plans, notes, guides, or README files.

Do Not Use When

  • The real task is inline code documentation.
  • The work is code implementation, not doc authoring.
  • The file is not markdown.

Procedure

  1. Read references/index.md first.
  2. Identify the document family:
    • guide
    • note
    • plan
    • general README or content doc
  3. Use the canonical template when the document family has one.
  4. Preserve the existing structure of the doc family unless the task is explicitly a reorganization.
  5. Apply the repo markdown rules:
    • real markdown links, not bare URLs
    • no unnecessary inline HTML
    • blank lines around headings and lists
    • language-tagged fenced code blocks when known
    • single trailing newline
  6. Keep prose lean. Prefer one canonical explanation over duplicated text across several files.
  7. If the task is markdown-focused or touches several markdown files, run a markdown lint pass before stopping when repo tooling is available.

References

Read references/index.md first.

Handoff Rules

  • Hand off to documentation if the real work is inline code docs rather than markdown documents.
  • Hand off to write-notes if the main question is where a note belongs and how to consolidate it without note sprawl.

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.

Reviews can't be read right now.

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