How do I install the Md Writer skill?

Run npx skillmds@latest add skrrt-sh/md-writer in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Md Writer safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Md Writer?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Md Writer free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Md Writer?

skrrt-sh (@skrrt-sh) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Md Writer by skrrt-sh — Agent Skill

Name: Md Writer
Author: skrrt-sh

Md Writer

Write or edit knowledge-base Markdown with frontmatter, Mermaid diagrams, related-document links, and markdownlint validation. Use for guides, specs, ADRs, runbooks, and API documentation; not repository meta files such as README, CHANGELOG, CLAUDE.md, AGENTS.md, or SKILL.md.

skrrt-sh cbff2f3 9 files · 59.1 KB Updated Sep 17, 2026

File contents

Markdown Authoring

Write readable, lint-clean knowledge-base documents. Match an established local convention before applying this skill's defaults.

Document shape

Use this frontmatter for new documents, omitting fields whose values are unknown:

---
title: "Document title"
description: "One-sentence purpose"
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
status: "draft"
---

Add author, version, tags, category, aliases, related, refs, or audience only when the user, repository, or document supplies a real value. Never invent metadata. For new documents, use today's date and version: "1.0.0" only when the repository versions individual documents.

Make the H1 match title. Follow it with a one-line blockquote summary. Add a table of contents when it materially improves navigation, typically at five or more H2 sections.

Diagrams

Use Mermaid instead of ASCII art. Choose the diagram type that fits the relationship. Use <br/> for line breaks in labels; a literal \n does not render as a break.

flowchart TD
    A["First line<br/>second line"] --> B["Result"]

Formatting

Wrap prose at 120 characters; exempt code blocks and tables.
Avoid inline HTML outside Mermaid content.
Use compact tables with single-space cell padding.
Name files with lowercase hyphenated words.
Give every fenced code block a language.

Validate

From the target repository, run ${CLAUDE_SKILL_DIR}/scripts/validate-md.sh <file.md> on every changed in-scope Markdown file. It may rewrite mechanical formatting; re-read a changed file before editing it again. Fix reported judgment-based violations and repeat until clean.

Read references/validation.md only when validation is skipped, cannot start, or reports a violation.

---name: md-writerdescription: Write or edit knowledge-base Markdown with frontmatter, Mermaid diagrams, related-document links, and markdownlint validation. Use for guides, specs, ADRs, runbooks, and API documentation; not repository meta files such as README, CHANGELOG, CLAUDE.md, AGENTS.md, or SKILL.md.---# Markdown AuthoringWrite readable, lint-clean knowledge-base documents. Match an established local convention beforeapplying this skill's defaults.## Document shapeUse this frontmatter for new documents, omitting fields whose values are unknown:```yaml---title: "Document title"description: "One-sentence purpose"created: "YYYY-MM-DD"updated: "YYYY-MM-DD"status: "draft"---```Add `author`, `version`, `tags`, `category`, `aliases`, `related`, `refs`, or `audience` only whenthe user, repository, or document supplies a real value. Never invent metadata. For new documents,use today's date and `version: "1.0.0"` only when the repository versions individual documents.Make the H1 match `title`. Follow it with a one-line blockquote summary. Add a table of contentswhen it materially improves navigation, typically at five or more H2 sections.## DiagramsUse Mermaid instead of ASCII art. Choose the diagram type that fits the relationship. Use `<br/>`for line breaks in labels; a literal `\n` does not render as a break.```mermaidflowchart TD A["First line<br/>second line"] --> B["Result"]```## Formatting- Wrap prose at 120 characters; exempt code blocks and tables.- Avoid inline HTML outside Mermaid content.- Use compact tables with single-space cell padding.- Name files with lowercase hyphenated words.- Give every fenced code block a language.## Related documentsFor a document in an existing knowledge base, search nearby Markdown files and titles for genuinetopic, dependency, or parent/child overlap. Add deduplicated relative paths to this document's`related` field. Edit existing documents to add backlinks only when the user asked forbidirectional links; update only their `related` and `updated` fields.## ValidateFrom the target repository, run`${CLAUDE_SKILL_DIR}/scripts/validate-md.sh <file.md>` on every changed in-scope Markdownfile. It may rewrite mechanical formatting; re-read a changed file before editing it again. Fixreported judgment-based violations and repeat until clean.Read [references/validation.md](references/validation.md) only when validation is skipped, cannotstart, or reports a violation.

Frequently asked questions