Markdown and Mermaid Writing
Writes Markdown docs and Mermaid text diagrams for workflows, timelines, schemas and architecture.
- Repository
- K-Dense-AI/scientific-agent-skills
- Stars
- 55,780
- Licence
- MIT
- Files
- 15 files
What it does
Once installed, the agent writes Markdown reports and README-style documents and draws structural diagrams (flowcharts, timelines, schemas, architecture, Gantt charts and more) as Mermaid code embedded in the text, so the diagram stays as editable plain text that version control can track. It consults a set of per-diagram-type reference guides and a house style that includes accessibility labels and rendering-version notes. It is explicitly not a tool for quantitative charts or statistical plots, which should be made with proper plotting software.
Great for
- Researchers or students who want reports and workflow diagrams kept as plain text in a git repository
- Developers writing READMEs or architecture docs who want diagrams that render on GitHub-style viewers
- Teams that maintain Mermaid sources alongside exported SVG or PNG figures
Skip it if
- Measured data charts, statistical graphics or publication figures: the skill says to use scientific plotting tools instead, since Mermaid cannot faithfully represent them
- Viewers without Mermaid support, which may show only raw code rather than a rendered diagram
- Anyone needing a verified scientific claim: the skill itself says it does not replace scientific analysis and AI-generated illustrations must be fact-checked
Try asking
- “Write a methods overview in Markdown for my lab's sequencing pipeline and include a Mermaid flowchart of the steps”
- “Draw a Gantt chart of our grant project timeline as Mermaid code I can commit to the repo”
- “Create an ER diagram of the sample metadata schema in this README”
- “Turn this architecture description into a C4 diagram in Mermaid”
Install in 3 steps
- 1
Download the skill
The ZIP contains the 15 original files, the MIT licence and an attribution note.
markdown-mermaid-writing.zip - 2
Add it to your agent
Claude Code (all projects)
mkdir -p ~/.claude/skills && unzip markdown-mermaid-writing.zip -d ~/.claude/skills/Claude Code / Agent SDK (this project only)
mkdir -p .claude/skills && unzip markdown-mermaid-writing.zip -d .claude/skills/Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.
- 3
Ask for the task
No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.
Get better results
- Ask for the diagram type explicitly (flowchart, gantt, er, c4) so the agent loads the matching reference guide
- Keep the Mermaid source in the Markdown file and export SVG or PNG separately if you need an image for publication
- Check that your destination renders Mermaid and note the version, since rendering differs between platforms
What's inside
- assets/examples/example-research-report.md
- references/current-rendering.md
- references/diagrams/architecture.md
- references/diagrams/block.md
- references/diagrams/c4.md
- references/diagrams/class.md
- references/diagrams/complex_examples.md
- references/diagrams/er.md
- references/diagrams/flowchart.md
- references/diagrams/gantt.md
- references/diagrams/git_graph.md
- references/diagrams/kanban.md
- references/diagrams/mindmap.md
- references/diagrams/packet.md
- SKILL.md
Redistributed unmodified from K-Dense-AI/scientific-agent-skills under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.