md-writer

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.