Find your next skill
← All skills
Content

markdown-writer

Generates well-structured technical documentation in Markdown. Use when a user asks to write docs, create a README, document an API, write a how-to guide, ge...

The answer

Generates well-structured technical documentation in Markdown.

Install

npx terminal-skills install markdown-writer

Author's take / 作者点评

Clean helper for structured Markdown drafting. Good for docs/READMEs; pair with markdownlint if your repo enforces rules.

写结构清晰的 Markdown/README 很顺手;仓库若有 markdownlint 仍要对齐规则。

What it does

Generates well-structured technical documentation in Markdown. Use when a user asks to write docs, create a README, document an API, write a how-to guide, generate technical documentation, create a changelog, write a project wiki, or produce any structured Markdown content. Follows documentation best practices for clarity and completeness.

This entry summarizes the public skill for discovery. Prefer the upstream SKILL.md for the full instruction text (we do not paste restricted or lengthy proprietary prompt bodies).

Install & usage

Multi-agent install (Terminal Skills CLI)

npx terminal-skills install markdown-writer

Manual curl examples:

# Claude Code
curl -sL https://raw.githubusercontent.com/TerminalSkills/skills/main/skills/markdown-writer/SKILL.md -o .claude/skills/markdown-writer.md
# Codex
curl -sL https://raw.githubusercontent.com/TerminalSkills/skills/main/skills/markdown-writer/SKILL.md -o .codex/skills/markdown-writer.md
# Cursor
curl -sL https://raw.githubusercontent.com/TerminalSkills/skills/main/skills/markdown-writer/SKILL.md -o .cursor/skills/markdown-writer.md

Best for

Technical documentation with consistent structure.

Hands-on test

  • test_level: fully-tested
  • Ran: yes
  • When: 2026-11-01T01:20:00+08:00 (Asia/Shanghai)
  • Result: Generated a structured Markdown doc with headings/lists and verified file write.
  • Gotchas: Style guidance is soft; project lint (markdownlint) may still fail.

Money-saving tip

Skills are free/open-source; spend goes to your agent plan. Start on Cursor Plus ($8/mo) or Claude Pro / ChatGPT Go before upgrading.

Source & license