skills.rest
SaschaLeh
SaschaLehCOMMUNITY
Explore all skills by this author →
Website𝕏@derLehmann_SGitHub

markdown-docs

Standardize Markdown documentation with YAML frontmatter and content guidelines.

Updated Aug 29, 2023
Search Tags:#documentation#markdown#mermaid#formatting#tables#code-blocks#headings
One-click install
npx skills add https://github.com/SaschaLeh/dotfiles --skill markdown-docs-saschaleh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: markdown-docs
Source: https://github.com/SaschaLeh/dotfiles/tree/main/dot_claude/skills/markdown-docs
Command: npx skills add https://github.com/SaschaLeh/dotfiles --skill markdown-docs-saschaleh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes Markdown documentation quality.

Core Features & Use Cases

  • Provides formatting guidelines for tables, headings, lists, code blocks, and Mermaid diagrams.
  • Helps teams maintain consistent documentation style across READMEs, guides, and technical docs.
  • Use Case: When authoring new documentation, apply these guidelines to ensure consistent structure and presentation.

Quick Start

Follow these guidelines when creating or revising Markdown files to ensure clarity and consistency.

Frequently Asked Questions about markdown-docs

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

FAQPage Schema
What are the guidelines for writing clean Markdown documentation?▼

Clean Markdown documentation requires YAML frontmatter with name and description, plus consistent formatting for tables, headings, lists, code blocks, and Mermaid diagrams to ensure clarity across technical docs and READMEs.

How do I standardize Markdown formatting across technical docs and README files?▼

Standardize Markdown formatting by applying content guidelines for tables, headings, lists, code blocks, and Mermaid diagrams, while enforcing YAML frontmatter with name and description for consistent structure across README files and technical docs.

Does this approach support Mermaid diagrams and code blocks in Markdown files?▼

Yes, the guidelines specifically include content rules for formatting code blocks and Mermaid diagrams within Markdown files, ensuring consistent presentation and structure for technical documentation.

What is the best way to format tables and headings in Markdown documentation?▼

The best way to format tables and headings is to follow standardized content guidelines that enforce consistent structure and presentation, ensuring your Markdown documentation remains clean and readable for users.

When do I need YAML frontmatter in my Markdown documentation?▼

You need YAML frontmatter with name and description fields whenever authoring or revising Markdown files, as it imposes standardized documentation quality and ensures consistent metadata across README files and technical guides.

Related Skills

Explore More Content & Communication Skills→
AVIDS2AVIDS2
618

valid-skill

Validate SKILL.md frontmatter and Markdown body against the Agent Skills standard.

Community
Basic
AlamatorAlamator

landing-page-generator

Generate deploy-ready static HTML/CSS/JS landing pages from repository README, docs, and assets.

Community
Advanced
KrystianYCSilvaKrystianYCSilva

markdown-expert

Create Markdown documentation with Mermaid diagrams and GFM tables.

Community
Intermediate
Mahaboob26Mahaboob26

markdown-documentation

Create structured Markdown documentation with GitHub Flavored Markdown formatting.

Community
Basic