markdown-mermaid-writing

Featured

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.

Data & Documents 882 stars 76 forks Updated 1 months ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
98
Recency 20%
75
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
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
LeonChaoX
Repository
LeonChaoX/qinyan-academic-skills
Created
6 months ago
Last Updated
1 months ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

markdown-mermaid-writing

Create versionable Mermaid diagrams and apply consistent Markdown structure to research artefacts. Use for workflows, timelines, concept maps, architectures, screening flows, and other structural diagrams; use scientific-visualization for data-derived charts and writing-skill for prose drafting.

0 Updated 4 days ago
timsmykov
AI & Automation Listed

mermaid-diagram-builder

Creates clear, valid, version-controllable diagrams as code using Mermaid — flowcharts, sequence diagrams, ER diagrams, class diagrams, state machines, Gantt charts, C4/architecture diagrams, and more. Use this skill when the user asks to "draw a diagram", "make a flowchart", "create a sequence diagram", "diagram this architecture", "visualize this process/data model/API flow", "show the ER diagram", "render Mermaid", "diagram as code", or wants a chart embeddable in Markdown, GitHub, Notion, or docs. Covers picking the right diagram type, writing syntactically correct Mermaid, styling, and validating that it renders.

5 Updated 1 months ago
JayRHa
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 1 months ago
fabioc-aloha