markdown-mermaid-writing
Writes scientific documents and documentation as markdown with embedded Mermaid diagrams as the canonical, git-diffable source format. Covers a markdown style guide, a Mermaid style guide, 24 Mermaid diagram type references (flowchart, sequence, ER, Gantt, state, mindmap, radar, sankey, XY chart, and others), and 9 templates (research paper, status report, decision record, how-to, pull request, issue, kanban, presentation, project documentation). Use when writing a report, manuscript, README, or analysis in markdown. Use when adding a workflow, pipeline, timeline, or architecture diagram to a document. Use when choosing the right Mermaid diagram type or fixing Mermaid syntax such as radar-beta or xychart-beta. Use when starting from a document template or checking citations and heading rules. Not for scatter plots of real data or photorealistic images; use Python plotting or scientific-schematics for those.
- Version
- 1.1
- License
- Apache-2.0
Pinned to revision df088027ff23, so it is the text this page describes rather than whatever the author pushed since.
Pre-approved tools experimental
Experimental field. Support varies between clients, so this list is what the author declared, not what your client will enforce.
- Read
- Write
- Edit
- Bash
Files
- skills/markdown-mermaid-writing/SKILL.md
- skills/markdown-mermaid-writing/assets/examples/example-research-report.md
- skills/markdown-mermaid-writing/references/diagrams/architecture.md
- skills/markdown-mermaid-writing/references/diagrams/block.md
- skills/markdown-mermaid-writing/references/diagrams/c4.md
- skills/markdown-mermaid-writing/references/diagrams/class.md
- skills/markdown-mermaid-writing/references/diagrams/complex_examples.md
- skills/markdown-mermaid-writing/references/diagrams/er.md
- skills/markdown-mermaid-writing/references/diagrams/flowchart.md
- skills/markdown-mermaid-writing/references/diagrams/gantt.md
- skills/markdown-mermaid-writing/references/diagrams/git_graph.md
- skills/markdown-mermaid-writing/references/diagrams/kanban.md
- skills/markdown-mermaid-writing/references/diagrams/mindmap.md
- skills/markdown-mermaid-writing/references/diagrams/packet.md
- skills/markdown-mermaid-writing/references/diagrams/pie.md
- skills/markdown-mermaid-writing/references/diagrams/quadrant.md
- skills/markdown-mermaid-writing/references/diagrams/radar.md
- skills/markdown-mermaid-writing/references/diagrams/requirement.md
- skills/markdown-mermaid-writing/references/diagrams/sankey.md
- skills/markdown-mermaid-writing/references/diagrams/sequence.md
- skills/markdown-mermaid-writing/references/diagrams/state.md
- skills/markdown-mermaid-writing/references/diagrams/timeline.md
- skills/markdown-mermaid-writing/references/diagrams/treemap.md
- skills/markdown-mermaid-writing/references/diagrams/user_journey.md
- skills/markdown-mermaid-writing/references/diagrams/xy_chart.md
- skills/markdown-mermaid-writing/references/diagrams/zenuml.md
- skills/markdown-mermaid-writing/references/markdown_style_guide.md
- skills/markdown-mermaid-writing/references/mermaid_style_guide.md
- skills/markdown-mermaid-writing/templates/decision_record.md
- skills/markdown-mermaid-writing/templates/how_to_guide.md
- skills/markdown-mermaid-writing/templates/issue.md
- skills/markdown-mermaid-writing/templates/kanban.md
- skills/markdown-mermaid-writing/templates/presentation.md
- skills/markdown-mermaid-writing/templates/project_documentation.md
- skills/markdown-mermaid-writing/templates/pull_request.md
- skills/markdown-mermaid-writing/templates/research_paper.md
- skills/markdown-mermaid-writing/templates/status_report.md
Every link opens the file at its source, pinned to the revision this page describes.