markdown-mermaid-writing
This skill establishes markdown with embedded Mermaid diagrams as the source format for scientific documents, reports, and technical writing. It includes 24 diagram type references, 9 document templates, and comprehensive style guides to enforce consistent, version-control-friendly documentation. Text-based diagrams render natively on GitHub, GitLab, and Notion without build steps, remain editable, and stay smaller than prose descriptions.
markdown-mermaid-writing creates text-based Mermaid diagrams embedded in markdown as the canonical format for scientific documentation and version control.
AI-generated summary based on this skill's SKILL.md
Decision gist · record as of 2026-07-28
markdown-mermaid-writing creates text-based Mermaid diagrams embedded in markdown as the canonical format for scientific documentation and version control. This skill establishes markdown with embedded Mermaid diagrams as the source format for scientific documents, reports, and technical writing. It includes 24 diagram type references, 9 document templates, and comprehensive style guides to enforce consistent, version-control-friendly documentation. Text-based diagrams render natively on GitHub, GitLab, and Notion without build steps, remain editable, and stay smaller than prose descriptions.
Use it when
- markdown-mermaid-writing includes 24 diagram type references covering flowcharts, sequence diagrams, class diagrams, state machines.
- markdown-mermaid-writing provides 9 document templates and comprehensive style guides for consistent technical writing.
Verify before relying
Read SKILL.md below before installing (37 files). Open directory: indexed for reading, not audited.
Install
K-Dense-AI/scientific-agent-skills/markdown-mermaid-writing · repository language: Python
Open directory. Skills are indexed for reading, not audited. Review a skill's body before installing it.
Frequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I embed diagrams in markdown files?
markdown-mermaid-writing embeds Mermaid diagrams directly in markdown using triple-backtick code blocks with the `mermaid` language identifier. Simply write your diagram syntax between the backticks—no external tools needed. The diagrams render natively on GitHub, GitLab, and Notion without build steps, staying fully editable and version-control friendly.
What diagram types does markdown-mermaid-writing support?
markdown-mermaid-writing includes 24 diagram type references covering flowcharts, sequence diagrams, class diagrams, state machines, Gantt charts, pie charts, entity-relationship diagrams, and more. Each type includes syntax examples and use-case guidance so you can select the right diagram for architecture, workflows, scientific processes, and technical reports.
How to write markdown with mermaid diagrams for documentation?
markdown-mermaid-writing provides 9 document templates and comprehensive style guides for consistent technical writing. Templates cover project documentation, scientific reports, and architecture specs. The guides enforce naming conventions, color schemes, and layout standards while keeping diagrams text-based, token-efficient, and smaller than prose descriptions.
Why use text-based diagrams instead of images?
markdown-mermaid-writing advocates text-based diagrams because they remain editable, diff-readable in git, and version-control friendly. Unlike PNG or JPG files, Mermaid source stays human-readable in commits, requires no external image editors, and renders consistently across platforms. They're also more accessible and serve as a single source of truth before any image conversion.
Does markdown-mermaid-writing include a style guide?
Yes. markdown-mermaid-writing includes a comprehensive style guide and examples for consistent documentation standards. It covers Mermaid syntax best practices, markdown formatting conventions, accessibility requirements, and templates for reports, architecture diagrams, and workflows—ensuring all team members produce uniform, professional technical documentation.
Can markdown-mermaid-writing diagrams be converted to images?
markdown-mermaid-writing treats Mermaid source as the primary format and source of truth. While Mermaid diagrams can be converted to PNG or SVG using CLI tools or online renderers, the skill emphasizes keeping diagrams in text form for version control, editability, and accessibility. Conversion is optional and happens downstream of documentation.
SKILL.md
Rendered from the published skill. Quoted content, verbatim.
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
(truncated - see the full file via the links below)
File tree — 15 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
Let your AI agent find skills like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 56,283 agent skills by what they can do, searchable in plain language.
wish › “Create and embed Mermaid diagrams in markdown files for scientific and technical documentation”
Give your agent the search over MCP, or paste the wish link into any chat. No install? Search from any chat →
Related skills
Charting & Diagrams generates interactive Mermaid visualizations across 23 diagram types—from flowcharts and class diagrams to Gantt charts, pie charts, and architecture layouts. Output diagrams as code blocks that render automatically, supporting everything from workflow logic and database schemas to project timelines and system design.
Create and validate Mermaid diagrams across multiple types—flowcharts for processes, sequence diagrams for system interactions, class and state diagrams for object models and lifecycles, ER diagrams for data relationships, and other specialized formats like Gantt charts. The skill preserves editable source while optionally rendering static SVG assets when needed for documents or slides.
A prerequisite skill that prepares your diagram requests for Figma's generate_diagram tool. It routes you to type-specific guidance, enforces universal Mermaid constraints, and tells you when to use a different approach or edit in Figma instead. Load it before every diagram call to avoid preventable failures.
Mermaid Graph Writer produces syntactically correct Mermaid diagrams by selecting the right diagram type for your content and applying consistent formatting rules. It handles flowcharts, sequence diagrams, state machines, ER models, timelines, mindmaps, Gantt charts, and other Mermaid-supported formats—but doesn't render them to images.
Design Doc Mermaid transforms descriptions and source code into visual diagrams across multiple types—activity flows, deployment infrastructure, system architecture, and API sequences. It includes specialized guides for different diagram categories, code-to-diagram workflows for popular frameworks, and Python utilities for extraction and image conversion.
Mermaid Diagrams converts text-based syntax into visual diagrams—flowcharts, sequence charts, ER models, class diagrams, Gantt timelines, and more. Embed diagrams directly in Markdown files and documentation. Perfect for system architecture, data modeling, and project planning without leaving your editor.
More skills mermaid-diagramming (MIT) · mermaid-diagram-generator (MIT)