agentleFS
Sign inStart free
hugobatistahugobatista/agent-skills/skills/docs/markdown-style/SKILL.md

markdown-style

Skill1 starsChanged 53 days agoMITView on GitHub

Use when writing or editing Markdown documentation (*.md files). Covers GFM formatting, content structure, headings, lists, code blocks, links, images, tables, and front matter.

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 2 are distinctive, and 1 is 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.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    H1 emoji: When writing a project README (where H1 is the title), append a descriptive emoji icon after the title text — e.g.

    line 9
  2. Distinctive:

    When front matter is required, include relevant metadata fields.

    line 19
  3. Distinctive:

    Run validation tools to verify front matter completeness, content rules, and formatting compliance.

    line 30

≈ “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

Content Rules

  • Headings: H2/H3 only — no H1 (auto-generated). Hierarchical order; recommend restructuring at H4+
  • H1 emoji: When writing a project README (where H1 is the title), append a descriptive emoji icon after the title text — e.g. # Project Name 🚀
  • Lists: - for bullets, 1. for numbered. Two-space indent for nesting
  • Code blocks: Fenced with triple backticks; always specify language
  • Links: [text](URL) — descriptive text, valid URL
  • Images: ![alt text](URL) — always include alt text
  • Tables: |-delimited with aligned headers
  • Line length: Max 400 chars; soft-break long paragraphs at ~80 chars
  • Whitespace: Blank lines between sections; no excessive whitespace

Front Matter

When front matter is required, include relevant metadata fields. Common fields:

title:
description:
author: hugobatista
date:
tags:

Validation

Run validation tools to verify front matter completeness, content rules, and formatting compliance.

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