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.Category: research-writing · License: Apache-2.0 · Version: 1.1
