mcpField
M
markdown

markdown

github.com/bseneDocuments739 installsUpdated 5d ago
Repository

About markdown

A syntax reference skill for people writing GitHub content in GitHub Flavored Markdown (GFM). It covers standard Markdown and GitHub-specific extensions, with notes on common rendering limits and pitfalls.

Key features

  1. 01Text and code formatting syntax
  2. 02Task lists and nested list guidance
  3. 03Alerts, footnotes, and mentions
  4. 04Anchor generation and common pitfalls

Use cases

  1. 01Look up GitHub Markdown syntax
  2. 02Check list, line-break, and anchor formatting

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bsene/skills --skill markdown

After installing, type/markdownin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
alerts-footnotes-mentions.md
links-and-images.md
lists-and-tasks.md
quick-ref.md
text-and-headings.md

Details

From the project README

GitHub Flavored Markdown (GFM)

Based on the official GitHub Basic Writing and Formatting Syntax reference.

GFM is a superset of standard Markdown with GitHub-specific extensions for issues, PRs, discussions, comments, and .md files.


Syntax At A Glance

FeatureSyntax
Heading# H1 … ###### H6
Bold**text**
Italic_text_
Strikethrough~~text~~
Link[text](url)
Image![alt](url)
Code inline`code`
Code block``` lang … ```
Blockquote> text
Unordered list- item
Ordered list1. item
Task list- [ ] task / - [x] done
Alert> [!NOTE] / [!TIP] / [!WARNING] / [!IMPORTANT] / [!CAUTION]
Footnotetext[^1] … [^1]: note
Mention@user / @org/team
Issue ref#42
Emoji:tada:
Escape\*literal\*
Comment<!-- hidden -->

Read On Demand

Read WhenFile
One-line syntax lookup for any GFM featureQuick Reference
Headings, text styling, code blocks, line breaks, escapingText & Headings
Links (inline, section, relative, custom anchors), imagesLinks & Images
Ordered/unordered lists, nesting, task listsLists & Tasks
Alerts, footnotes, mentions, emojisAlerts, Footnotes & Mentions

Common Pitfalls

  • Line breaks in .md files require two trailing spaces, a \, or <br/> — a plain newline won't break the line.
  • Nested list indentation must visually align the child marker under the first text character of the parent item.
  • Section anchor generation: lowercase, spaces become -, all other punctuation stripped. Duplicate headings get -1, -2 suffixes — update any links if you reorder headings.
  • Alerts cannot be nested inside other elements and should be used sparingly.
  • Footnotes are not supported in GitHub wikis.
  • Color swatches (`#hex`, `rgb()`, `hsl()`) only render in issues, PRs, and discussions — not in plain .md file views.
  • Custom anchors (<a name="">) are not included in the auto-generated table of contents.

Benchmark

Scenario: .benchmarks/scenarios/markdown-001-wiki-limits.md · Run: 2026-08-31 · Log: .benchmarks/runs/2026-08-31/markdown-001-wiki-limits.json

ModelWithoutWithDelta
claude-opus-4-8100%100%+0%
claude-sonnet-4-6100%100%+0%
claude-haiku-4-580%100%+20%

SOFT PASS (run 2026-08-31). Haiku +20 (80→100); opus/sonnet at ceiling. Gate per .agents/skills/skill-optimizer/rules/release-gates.md.

Comments

Markdown supported