markdown-mermaid-writing

Solid

Comprehensive markdown and Mermaid diagram writing skill that establishes text-based diagrams as the DEFAULT documentation standard. Use this skill when creating ANY scientific document, report, analysis, or visualization — it ensures all outputs are in version-controlled, token-efficient markdown with embedded Mermaid diagrams as the source of truth, with clear pathways to downstream Python or AI-generated images. Includes full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates ready to use.

AI & Automation 2,210 stars 164 forks Updated 1 weeks ago Apache-2.0

Install

View on GitHub

Quality Score: 97/100

Stars 20%
100
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Markdown and Mermaid Writing ## Overview This skill teaches you — and enforces a standard for — creating scientific documentation using **markdown with embedded Mermaid diagrams as the default and canonical format**. The core bet: a relationship expressed as a Mermaid diagram inside a `.md` file is more valuable than any image. It is text, so it diffs cleanly in git. It requires no build step. It renders natively on GitHub, GitLab, Notion, VS Code, and any markdown viewer. It uses fewer tokens than a prose description of the same relationship. And it can always be converted to a polished image later — but the text version remains the source of truth. > "The more you get your reports and files in .md in just regular text, which mermaid is > as well as being a simple 'script language'. This just helps with any downstream rendering > and especially AI generated images (using mermaid instead of just long form text to > describe relationships < tokens). Additionally mermaid can render along with markdown for > easy use almost anywhere by humans or AI." > > — Clayton Young (@borealBytes), K-Dense Discord, 2026-02-19 ## When to Use This Skill Use this skill when: - Creating **any scientific document** — reports, analyses, manuscripts, methods sections - Writing **any documentation** — READMEs, how-tos, decision records, project docs - Producing **any diagram** — workflows, data pipelines, architectures, timelines, relationships - Generating **any output that will be version...

Details

Author
foryourhealth111-pixel
Repository
foryourhealth111-pixel/Vibe-Skills
Created
3 months ago
Last Updated
1 weeks ago
Language
Python
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Featured

markdown-mermaid-writing

Comprehensive markdown and Mermaid diagram writing skill. Use when creating any scientific document, report, analysis, or visualization. Establishes text-based diagrams as the default documentation standard with full style guides (markdown + mermaid), 24 diagram type references, and 9 document templates.

26,817 Updated today
K-Dense-AI
AI & Automation Listed

markdown-mermaid

Author markdown and Mermaid diagrams that render correctly in VS Code, GitHub, and other Mermaid 10+ consumers — covers diagram-tool selection, mandatory init template, parser pitfalls, and visual design rules. Use when writing technical docs with embedded diagrams, debugging Mermaid render failures, or choosing between Mermaid, Excalidraw, and other diagramming tools.

0 Updated yesterday
fabioc-aloha
Code & Development Listed

technical-diagrams

Provides Mermaid diagram syntax, best practices, and styling rules for technical visualizations. Use when creating diagrams, flowcharts, sequence diagrams, class diagrams, state diagrams, ER diagrams, architecture diagrams, C4 diagrams, visualizations, or any visual documentation in markdown. Always use this skill when generating or updating Mermaid code blocks.

38 Updated today
sequenzia
AI & Automation Listed

mermaid-diagram

Generate beautiful Mermaid diagrams — flowcharts, sequence, ER, class, state, pie, gantt, mindmap, timeline, gitgraph, C4, kanban, block, quadrant, sankey, XY charts. Renders to PNG locally and Markdown for GitHub. Use when the user asks for diagrams, visualizations, schemas, flowcharts, architecture overviews, database schemas, API flows, project timelines, git branching strategies, org charts, or any visual representation of systems, workflows, or data.

24 Updated 2 days ago
georgekhananaev
AI & Automation Listed

mermaid

Side-route utility skill for generating Mermaid diagram code from a description. Use when the user wants a flowchart, sequence diagram, class diagram, ER diagram, state machine, Gantt chart, mindmap, C4 architecture, user journey, or any of 23 supported Mermaid diagram types — often during /shape, /research, /write-a-prd, or /prd-to-issues when a visual would clarify scope, flow, or structure. Not for free-form ASCII sketches, hand-drawn whiteboards (use /excalidraw-diagram for that), or rendering diagrams to images.

2 Updated 2 days ago
chrislacey89