md-writer

Create Markdown documents with YAML frontmatter, Mermaid diagrams, and markdownlint compliance.

2|Updated Feb 24, 2026
One-click install
npx skills add https://github.com/skrrt-sh/skills --skill md-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: md-writer
Source: https://github.com/skrrt-sh/skills/tree/main/plugins/md-writer/skills/md-writer
Command: npx skills add https://github.com/skrrt-sh/skills --skill md-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write well-structured Markdown documents by enforcing YAML frontmatter, Mermaid diagrams, and markdownlint-compliant formatting. This ensures consistent metadata, diagrams, and lint-ready outputs across projects.

Core Features & Use Cases

  • Enforces YAML frontmatter structure for Markdown docs (title, description, author, created, updated, version, status).
  • Provides guidance for including Mermaid diagrams and maintaining markdownlint compliance.
  • Skips frontmatter for well-known repo files while guiding the creation of knowledge-base documents.
  • Use cases include API docs, runbooks, ADRs, architecture guides, and developer documentation.

Quick Start

Create a Markdown document following the frontmatter rules and apply the project’s lint configuration.

Frequently Asked Questions about md-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce YAML frontmatter in Markdown documentation?

To enforce YAML frontmatter in Markdown, this Skill applies required metadata fields like title, description, author, created, updated, version, and status. It streamlines knowledge-base documents by automatically structuring frontmatter for guides, specs, ADRs, runbooks, and API docs.

How do I add Mermaid diagrams to Markdown docs while ensuring markdownlint compliance?

You can add Mermaid diagrams to Markdown docs while ensuring markdownlint compliance by using this Skill. It provides structural guidance for embedding Mermaid syntax and automatically applies project-configured linting rules to maintain consistent formatting across your documentation.

Can I skip frontmatter for standard repository files like READMEs?

Yes, you can skip frontmatter for standard repository files. This Skill automatically omits YAML frontmatter for well-known repo files, while still guiding the creation and markdownlint compliance of broader knowledge-base documents like runbooks and architecture guides.

What is the best way to structure ADRs and runbooks with Mermaid diagrams?

The best way to structure ADRs and runbooks with Mermaid diagrams is to use a formatting Skill that enforces required YAML frontmatter and linting rules. This ensures metadata consistency and diagram validity across architecture guides and operational documentation.

Does this Markdown formatting Skill support custom markdownlint configuration?

Yes, this Markdown formatting Skill supports custom markdownlint configuration. It applies your project-configured linting rules to ensure all generated Markdown documents meet specific formatting standards required by your team's knowledge base.

Why are my Markdown documents failing markdownlint checks?

Markdown documents often fail markdownlint checks due to inconsistent formatting or missing required elements. This Skill enforces markdownlint-compliant formatting and validates YAML frontmatter to ensure your API docs, guides, and specs pass linting checks consistently.