Markdown Mermaid Writing
Comprehensive markdown and Mermaid diagram writing skill.
Install
npx skills add LeonChaoX/qinyan-academic-skills --skill markdown-mermaid-writing -g -a claude-code -y- Repository
- LeonChaoX/qinyan-academic-skills996
- Category
- Data and ML
- Updated
- 4mo ago
- License
- Apache-2.0
- Context cost
- Mediumabout 3,000 tokens
- Runs scripts
- No, instructions only
What it does
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.
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-controlled, if it's going into git, it should be markdown
- Working with any other skill, this skill defines the documentation layer that wraps every other output
- Someone asks you to "add a diagram" or "visualize the relationship", Mermaid first, always
