[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M73H4V8P34392RR6Z95M79TY":3,"skill-same:01M73H4V8P34392RR6Z95M79TY":58},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":18,"publishedAt":19,"linkOnly":20,"markdownContent":21,"markdownBody":22,"frontMatter":23,"refName":34,"commitSha":35,"skillDirectory":36,"forksCount":37,"repositoryHtmlUrl":38,"repositoryHomepageUrl":39,"ownerHtmlUrl":40,"ownerBlogUrl":41,"ownerDescription":42,"updatedAt":43,"install":44,"resources":57},"01M73H4V8P34392RR6Z95M79TY","markdown-mermaid-writing",null,"Writes scientific Markdown documentation and Mermaid diagrams for workflows, relationships, timelines, and schemas. Provides syntax references, document templates, accessibility guidance, and version-aware rendering checks. Use when a user requests Markdown, Mermaid, or a text-based structural diagram; quantitative scientific figures require suitable plotting tools.","bg-szy\u002FTOP-SKILLS","bg-szy","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F106576190?v=4","01M73A4E8KPV67SFXRY8XZGNBX","ShuZhiyong","01M73A4E96MQ294MHM74TZBVQD",6,"Apache-2.0","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fawesome-skills\u002Fmarkdown-mermaid-writing\u002FSKILL.md",[],[],"2026-11-11 15:11:14",false,"---\nname: markdown-mermaid-writing\ndescription: Writes scientific Markdown documentation and Mermaid diagrams for workflows, relationships, timelines, and schemas. Provides syntax references, document templates, accessibility guidance, and version-aware rendering checks. Use when a user requests Markdown, Mermaid, or a text-based structural diagram; quantitative scientific figures require suitable plotting tools.\nallowed-tools: Read Write Edit Bash\nlicense: Apache-2.0\ncompatibility: Markdown authoring needs no runtime. Local rendering targets Mermaid and Mermaid CLI 12.0.0, Node.js 22.13+ and a supported Chromium browser. Package or CDN installation needs network access; no credentials required.\nmetadata:\n  version: \"1.3\"\n  last-reviewed: \"2026-10-01\"\n  mermaid-tested: \"12.0.0\"\n  mermaid-cli-tested: \"12.0.0\"\n  skill-author: Clayton Young \u002F Superior Byte Works, LLC (@borealBytes)\n  skill-source: https:\u002F\u002Fgithub.com\u002FSuperiorByteWorks-LLC\u002Fagent-project\n  skill-version: 1.0.0\n  skill-contributors: Clayton Young (Superior Byte Works, LLC \u002F @borealBytes; Author and originator); K-Dense Team (K-Dense Inc.; Integration target and community feedback)\n---\n\n# Markdown and Mermaid Writing\n\n## Overview\n\nThis skill provides an optional house style for **Markdown documentation with Mermaid\nstructural diagrams**. Follow the requested output format, existing repository conventions,\nand journal requirements first. This skill does not replace scientific analysis or plotting.\n\nA relationship expressed as Mermaid inside a `.md` file is editable text that diffs\ncleanly in git. A compatible host renders it without a separate user build step.\nIt renders where the host has Mermaid support; plain Markdown viewers may show only code,\nand platforms\u002Fextensions ship different Mermaid versions. It uses\na compact source representation, though token use depends on the diagram. Exporting\nSVG\u002FPNG requires a renderer; retain the diagram source alongside exported figures.\n\n> \"The more you get your reports and files in .md in just regular text, which mermaid is\n> as well as being a simple 'script language'. This just helps with any downstream rendering\n> and especially AI generated images (using mermaid instead of just long form text to\n> describe relationships \u003C tokens). Additionally mermaid can render along with markdown for\n> easy use almost anywhere by humans or AI.\"\n>\n> — Clayton Young (@borealBytes), K-Dense Discord, 2026-02-19\n\n## When to Use This Skill\n\nUse this skill when:\n\n- Writing a requested Markdown report, README, methods overview, or research note\n- Diagramming a workflow, data pipeline, schema, state machine, or conceptual relationship\n- Maintaining editable Mermaid sources and their rendered SVG\u002FPNG exports\n\nUse scientific plotting tools directly for measured data, uncertainty, statistical graphics,\nexact geometry, or publication figures that Mermaid cannot faithfully represent. Mermaid\nis not a required precursor to a quantitative chart or an existing SVG\u002Fcode-native asset.\n\n## 🎨 The Source Format Philosophy\n\n### Why text-based diagrams win\n\n| What matters | Mermaid in Markdown | Python \u002F AI Image |\n| ----------------------------- | :-----------------: | :---------------: |\n| Git diff readable | ✅ text source | Plotting code\u002FSVG can also be text |\n| Editable source | ✅ | Plotting scripts and vector sources are editable |\n| Compact relationship notation | Often | Depends on representation |\n| Native preview | Host\u002Fversion dependent | Viewer\u002Fformat dependent |\n| Parseable by AI without vision | ✅ | ❌ |\n| Works in destination | Check Mermaid support and version | Check image format support |\n| Accessible (screen readers) | Check SVG metadata and text alternative | Provide alt text\u002Fdata table |\n| Convertible to image later | ✅ anytime | — already image |\n\n### The three-phase workflow\n\n```mermaid\nflowchart LR\n    accTitle: Three-Phase Documentation Workflow\n    accDescr: Markdown holds the structural diagram source. Quantitative charts come from data and plotting code; optional illustrations require a separate factual review.\n\n    p1[\"📄 Phase 1\u003Cbr\u002F>Mermaid in Markdown\u003Cbr\u002F>(structural source)\"]\n    p2[\"🐍 Phase 2\u003Cbr\u002F>Python Generated\u003Cbr\u002F>(optional — data charts)\"]\n    p3[\"🎨 Phase 3\u003Cbr\u002F>AI Generated Visuals\u003Cbr\u002F>(optional — polish)\"]\n    out[\"📊 Final Deliverable\"]\n\n    p1 --> out\n    data[\"Data and plotting code\"] --> p2\n    p1 -.->|\"when needed\"| p3\n    p2 --> out\n    p3 --> out\n\n    classDef required fill:#dbeafe,stroke:#2563eb,stroke-width:2px,color:#1e3a5f\n    classDef optional fill:#fef9c3,stroke:#ca8a04,stroke-width:2px,color:#713f12\n    classDef output fill:#dcfce7,stroke:#16a34a,stroke-width:2px,color:#14532d\n\n    class p1 required\n    class p2,p3 optional\n    class out output\n```\n\nRetain Mermaid for structural diagrams and data\u002Fcode for quantitative charts. An AI illustration\nis not a quantitative conversion; verify every label and relationship against its sources.\n\n### What Mermaid can express\n\nThis skill includes 23 diagram-type guides plus a composition guide. Mermaid supports\nadditional types; these references are a curated subset, not an exhaustive version catalogue:\n\n| Use case | Diagram type | File |\n| -------------------------------------------- | ---------------- | ---------------------------------------------------- |\n| Experimental workflow \u002F decision logic | Flowchart | `references\u002Fdiagrams\u002Fflowchart.md` |\n| Service interactions \u002F API calls \u002F messaging | Sequence | `references\u002Fdiagrams\u002Fsequence.md` |\n| Data model \u002F schema | ER diagram | `references\u002Fdiagrams\u002Fer.md` |\n| State machine \u002F lifecycle | State | `references\u002Fdiagrams\u002Fstate.md` |\n| Project timeline \u002F roadmap | Gantt | `references\u002Fdiagrams\u002Fgantt.md` |\n| Proportions \u002F composition | Pie | `references\u002Fdiagrams\u002Fpie.md` |\n| System architecture (zoom levels) | C4 | `references\u002Fdiagrams\u002Fc4.md` |\n| Concept hierarchy \u002F brainstorm | Mindmap | `references\u002Fdiagrams\u002Fmindmap.md` |\n| Chronological events \u002F history | Timeline | `references\u002Fdiagrams\u002Ftimeline.md` |\n| Class hierarchy \u002F type relationships | Class | `references\u002Fdiagrams\u002Fclass.md` |\n| User journey \u002F satisfaction map | User Journey | `references\u002Fdiagrams\u002Fuser_journey.md` |\n| Two-axis comparison \u002F prioritization | Quadrant | `references\u002Fdiagrams\u002Fquadrant.md` |\n| Requirements traceability | Requirement | `references\u002Fdiagrams\u002Frequirement.md` |\n| Flow magnitude \u002F resource distribution | Sankey | `references\u002Fdiagrams\u002Fsankey.md` |\n| Numeric trends \u002F bar + line charts | XY Chart | `references\u002Fdiagrams\u002Fxy_chart.md` |\n| Component layout \u002F spatial arrangement | Block | `references\u002Fdiagrams\u002Fblock.md` |\n| Work item status \u002F task columns | Kanban | `references\u002Fdiagrams\u002Fkanban.md` |\n| Cloud infrastructure \u002F service topology | Architecture | `references\u002Fdiagrams\u002Farchitecture.md` |\n| Multi-dimensional comparison \u002F skills radar | Radar | `references\u002Fdiagrams\u002Fradar.md` |\n| Hierarchical proportions \u002F budget | Treemap | `references\u002Fdiagrams\u002Ftreemap.md` |\n| Binary protocol \u002F data format | Packet | `references\u002Fdiagrams\u002Fpacket.md` |\n| Git branching \u002F merge strategy | Git Graph | `references\u002Fdiagrams\u002Fgit_graph.md` |\n| Code-style sequence (programming syntax) | ZenUML | `references\u002Fdiagrams\u002Fzenuml.md` |\n| Multi-diagram composition patterns | Complex Examples | `references\u002Fdiagrams\u002Fcomplex_examples.md` |\n\n> 💡 **Pick the right type, not the easy one.** Don't default to flowcharts for everything.\n> A timeline beats a flowchart for chronological events. A sequence beats a flowchart for\n> service interactions. Scan the table and match.\n\n---\n\n## 🔧 Core workflow\n\n### Step 1: Identify the document type\n\nCheck if a template exists before writing from scratch:\n\n| Document type | Template |\n| ------------------------------ | ----------------------------------------------- |\n| Pull request record | `templates\u002Fpull_request.md` |\n| Issue \u002F bug \u002F feature request | `templates\u002Fissue.md` |\n| Sprint \u002F project board | `templates\u002Fkanban.md` |\n| Architecture decision (ADR) | `templates\u002Fdecision_record.md` |\n| Presentation \u002F briefing | `templates\u002Fpresentation.md` |\n| Research paper \u002F analysis | `templates\u002Fresearch_paper.md` |\n| Project documentation | `templates\u002Fproject_documentation.md` |\n| How-to \u002F tutorial | `templates\u002Fhow_to_guide.md` |\n| Status report | `templates\u002Fstatus_report.md` |\n\n### Step 2: Read the style guide\n\nFor this Markdown workflow, read `references\u002Fmarkdown_style_guide.md`. Treat emoji,\nheading counts, and horizontal rules as house style rather than Markdown syntax requirements.\n\nKey rules to internalize:\n\n- **One H1 per document** — the title. Never more.\n- **Emoji on H2 headings only** — one emoji per H2, none in H3\u002FH4\n- **Support factual claims** — use verified sources and the requested citation format\n- **Bold sparingly** — max 2-3 bold terms per paragraph, never full sentences\n- **Optional horizontal rules** after `\u003C\u002Fdetails>` when they improve separation\n- **Tables over prose** for comparisons, configurations, structured data\n- **Diagrams over walls of text** — if it describes flow, structure, or relationships, add Mermaid\n\n### Step 3: Pick the diagram type and read its guide\n\nBefore creating any Mermaid diagram: read `references\u002Fmermaid_style_guide.md`.\n\nThen open the specific type file (e.g., `references\u002Fdiagrams\u002Fflowchart.md`) for the exemplar, tips, and copy-paste template.\n\nAdd accessibility metadata for types that emit it in the chosen renderer:\n\n```\naccTitle: Short Name 3-8 Words\naccDescr: One or two sentences explaining what this diagram shows.\n```\n\n- Prefer host themes; `%%{init}` directives are deprecated in favor of YAML configuration\n- Prefer reusable `classDef` where supported; style syntax is diagram-specific\n- **One emoji per node max** — at the start of the label\n- Use descriptive IDs with the type's syntax: `snake_case` works for flowcharts; ER\u002Fclass\u002Fstate conventions differ\n\n### Step 4: Write the document\n\nStart from the template. Apply the markdown style guide. Place diagrams inline with related text — not in a separate \"Figures\" section.\n\nRender in the **actual destination** before delivery. Check its Mermaid version and\nplugin requirements before choosing newer diagram types; [GitHub documents an `info`\ndiagram for this check](https:\u002F\u002Fdocs.github.com\u002Fen\u002Fget-started\u002Fwriting-on-github\u002Fworking-with-advanced-formatting\u002Fcreating-diagrams).\nA successful latest-version local preview does not establish GitHub or another host\nwill render it. Where Mermaid is unsupported, supply a rendered SVG\u002FPNG with a text\ndescription alongside the retained `.md` source.\n\n### Step 5: Retain source and verification\n\nKeep the `.md` source, rendered deliverable, and tested renderer version together.\nFollow the project's version-control workflow; this skill does not itself authorize a commit or publication.\nFor CLI export, embedding, and the tested accessibility matrix, read\n[Current rendering and validation](references\u002Fcurrent-rendering.md).\n\n---\n\n## ⚠️ Common pitfalls\n\n### Radar chart syntax (`radar-beta`)\n\n**WRONG (shown as text so it does not break the document renderer):**\n```text\nradar\ntitle Example\nx-axis [\"A\", \"B\", \"C\"]\n\"Series\" : [1, 2, 3]\n```\n\n**CORRECT:**\n```mermaid\nradar-beta\naccTitle: Example Radar Scores\naccDescr: Illustrative values of one, two, and three on a shared zero-to-three scale.\ntitle Example\naxis a[\"A\"], b[\"B\"], c[\"C\"]\ncurve series[\"Series\"]{1, 2, 3}\nmax 3\n```\n\n- **Use `radar-beta`** not `radar` (the bare keyword doesn't exist)\n- **Use `axis`** to define dimensions, **not** `x-axis`\n- **Use `curve`** to define data series, **not** quoted labels with colon\n- Mermaid 12.0.0 radar emits `accTitle`\u002F`accDescr`; check older hosts and retain a visible description\n\n### XY Chart vs Radar confusion\n\n| Diagram | Keyword | Axis syntax | Data syntax |\n| ------- | ------- | ----------- | ----------- |\n| **XY Chart** (bars\u002Flines) | `xychart-beta` | `x-axis [\"Label1\", \"Label2\"]` | `bar [10, 20]` or `line [10, 20]` |\n| **Radar** (spider\u002Fweb) | `radar-beta` | `axis id[\"Label\"]` | `curve id[\"Label\"]{10, 20}` |\n\n### Forgetting `accTitle`\u002F`accDescr` on supported types\n\nOnly some diagram types support `accTitle`\u002F`accDescr`. For those that don't, always place a descriptive italic paragraph directly above the code block:\n\n> _Radar chart comparing three methods on a stated, common score scale. See the data table for exact values._\n\n```text\nradar-beta\n...\n```\n\n---\n\n## 🔗 Integration with other skills\n\n### With `scientific-schematics`\n\n`scientific-schematics` generates AI-powered publication-quality images (PNG). Use the Mermaid diagram as the **brief** for the schematic:\n\n```\nWorkflow:\n1. Create the concept as Mermaid in .md (this skill — Phase 1)\n2. Describe the same concept to scientific-schematics for a polished PNG (Phase 3)\n3. Commit both — the .md as source, the PNG as a supplementary figure\n```\n\n### With `scientific-writing`\n\nFor a manuscript that uses Mermaid structural figures, this skill handles diagram syntax.\nFollow the manuscript's required figure formats and scientific visualization conventions.\n\n```\nWorkflow:\n1. Use scientific-writing to draft the manuscript\n2. For every figure that shows a workflow, architecture, or relationship:\n   - Replace placeholder with a Mermaid diagram following this skill's guide\n3. Use plotting or schematic tools where appropriate to the scientific content\n```\n\n### With `literature-review`\n\nLiterature review produces summaries with lots of relationship data. Use this skill to:\n\n- Create concept maps (Mindmap) of the literature landscape\n- Show publication timelines (Timeline or Gantt)\n- Compare methodologies (Quadrant or Radar)\n- Diagram data flows described in papers (Sequence or Flowchart)\n\n### With any skill that produces output documents\n\nBefore finalizing a document using this skill, check:\n\n- [ ] Does the document use a template? If so, did I start from the right one?\n- [ ] Is each diagram in an appropriate format, with working accessibility metadata or a text alternative?\n- [ ] Is configuration supported by the destination and tested in light\u002Fdark themes?\n- [ ] Do citations support external claims, and are synthetic values labeled?\n- [ ] One H1, emoji on H2 only?\n- [ ] Does the final Markdown\u002FHTML structure render correctly?\n\n---\n\n## 📚 Reference index\n\n### Style guides\n\n| Guide | Path | Lines | What it covers |\n| ----------------------- | ------------------------------------------- | ----- | -------------------------------------------------- |\n| Markdown Style Guide | `references\u002Fmarkdown_style_guide.md` | see file | Headings, formatting, citations, tables, Mermaid integration, templates, quality checklist |\n| Mermaid Style Guide | `references\u002Fmermaid_style_guide.md` | see file | Accessibility, emoji set, color classes, theme neutrality, type selection, complexity tiers |\n| Current Rendering | `references\u002Fcurrent-rendering.md` | see file | Mermaid 12 changes, CLI export, browser APIs, tested accessibility matrix, scientific checks |\n\n### Diagram guides (23 types plus composition)\n\nEach file contains: production-quality exemplar, tips specific to that type, and a copy-paste template.\n\n`references\u002Fdiagrams\u002F` — architecture, block, c4, class, complex\\_examples, er, flowchart, gantt, git\\_graph, kanban, mindmap, packet, pie, quadrant, radar, requirement, sankey, sequence, state, timeline, treemap, user\\_journey, xy\\_chart, zenuml\n\n### Document templates (9 types)\n\n`templates\u002F` — decision\\_record, how\\_to\\_guide, issue, kanban, presentation, project\\_documentation, pull\\_request, research\\_paper, status\\_report\n\n### Examples\n\n`assets\u002Fexamples\u002Fexample-research-report.md` — a synthetic quality-control report with explicitly invented data, an auditable count table, a structural flowchart, a bar chart, and a chronology. It makes no experimental or software API claims.\n\n---\n\n## 📝 Attribution\n\nAll style guides, diagram type guides, and document templates in this skill are ported from the `SuperiorByteWorks-LLC\u002Fagent-project` repository under the Apache-2.0 License.\n\n- **Source**: https:\u002F\u002Fgithub.com\u002FSuperiorByteWorks-LLC\u002Fagent-project\n- **Author**: Clayton Young \u002F Superior Byte Works, LLC (@borealBytes)\n- **License**: Apache-2.0\n\nThis skill (as part of scientific-agent-skills) is distributed under the MIT License. The included Apache-2.0 content is compatible for downstream use with attribution retained, as preserved in the file headers throughout this skill.\n\n---\n\n[^1]: GitHub Blog. (2022). \"Include diagrams in your Markdown files with Mermaid.\" https:\u002F\u002Fgithub.blog\u002F2022-02-14-include-diagrams-markdown-files-mermaid\u002F\n\n[^2]: Mermaid. \"Mermaid Diagramming and Charting Tool.\" https:\u002F\u002Fmermaid.js.org\u002F\n","# Markdown and Mermaid Writing\n\n## Overview\n\nThis skill provides an optional house style for **Markdown documentation with Mermaid\nstructural diagrams**. Follow the requested output format, existing repository conventions,\nand journal requirements first. This skill does not replace scientific analysis or plotting.\n\nA relationship expressed as Mermaid inside a `.md` file is editable text that diffs\ncleanly in git. A compatible host renders it without a separate user build step.\nIt renders where the host has Mermaid support; plain Markdown viewers may show only code,\nand platforms\u002Fextensions ship different Mermaid versions. It uses\na compact source representation, though token use depends on the diagram. Exporting\nSVG\u002FPNG requires a renderer; retain the diagram source alongside exported figures.\n\n> \"The more you get your reports and files in .md in just regular text, which mermaid is\n> as well as being a simple 'script language'. This just helps with any downstream rendering\n> and especially AI generated images (using mermaid instead of just long form text to\n> describe relationships \u003C tokens). Additionally mermaid can render along with markdown for\n> easy use almost anywhere by humans or AI.\"\n>\n> — Clayton Young (@borealBytes), K-Dense Discord, 2026-02-19\n\n## When to Use This Skill\n\nUse this skill when:\n\n- Writing a requested Markdown report, README, methods overview, or research note\n- Diagramming a workflow, data pipeline, schema, state machine, or conceptual relationship\n- Maintaining editable Mermaid sources and their rendered SVG\u002FPNG exports\n\nUse scientific plotting tools directly for measured data, uncertainty, statistical graphics,\nexact geometry, or publication figures that Mermaid cannot faithfully represent. Mermaid\nis not a required precursor to a quantitative chart or an existing SVG\u002Fcode-native asset.\n\n## 🎨 The Source Format Philosophy\n\n### Why text-based diagrams win\n\n| What matters | Mermaid in Markdown | Python \u002F AI Image |\n| ----------------------------- | :-----------------: | :---------------: |\n| Git diff readable | ✅ text source | Plotting code\u002FSVG can also be text |\n| Editable source | ✅ | Plotting scripts and vector sources are editable |\n| Compact relationship notation | Often | Depends on representation |\n| Native preview | Host\u002Fversion dependent | Viewer\u002Fformat dependent |\n| Parseable by AI without vision | ✅ | ❌ |\n| Works in destination | Check Mermaid support and version | Check image format support |\n| Accessible (screen readers) | Check SVG metadata and text alternative | Provide alt text\u002Fdata table |\n| Convertible to image later | ✅ anytime | — already image |\n\n### The three-phase workflow\n\n```mermaid\nflowchart LR\n    accTitle: Three-Phase Documentation Workflow\n    accDescr: Markdown holds the structural diagram source. Quantitative charts come from data and plotting code; optional illustrations require a separate factual review.\n\n    p1[\"📄 Phase 1\u003Cbr\u002F>Mermaid in Markdown\u003Cbr\u002F>(structural source)\"]\n    p2[\"🐍 Phase 2\u003Cbr\u002F>Python Generated\u003Cbr\u002F>(optional — data charts)\"]\n    p3[\"🎨 Phase 3\u003Cbr\u002F>AI Generated Visuals\u003Cbr\u002F>(optional — polish)\"]\n    out[\"📊 Final Deliverable\"]\n\n    p1 --> out\n    data[\"Data and plotting code\"] --> p2\n    p1 -.->|\"when needed\"| p3\n    p2 --> out\n    p3 --> out\n\n    classDef required fill:#dbeafe,stroke:#2563eb,stroke-width:2px,color:#1e3a5f\n    classDef optional fill:#fef9c3,stroke:#ca8a04,stroke-width:2px,color:#713f12\n    classDef output fill:#dcfce7,stroke:#16a34a,stroke-width:2px,color:#14532d\n\n    class p1 required\n    class p2,p3 optional\n    class out output\n```\n\nRetain Mermaid for structural diagrams and data\u002Fcode for quantitative charts. An AI illustration\nis not a quantitative conversion; verify every label and relationship against its sources.\n\n### What Mermaid can express\n\nThis skill includes 23 diagram-type guides plus a composition guide. Mermaid supports\nadditional types; these references are a curated subset, not an exhaustive version catalogue:\n\n| Use case | Diagram type | File |\n| -------------------------------------------- | ---------------- | ---------------------------------------------------- |\n| Experimental workflow \u002F decision logic | Flowchart | `references\u002Fdiagrams\u002Fflowchart.md` |\n| Service interactions \u002F API calls \u002F messaging | Sequence | `references\u002Fdiagrams\u002Fsequence.md` |\n| Data model \u002F schema | ER diagram | `references\u002Fdiagrams\u002Fer.md` |\n| State machine \u002F lifecycle | State | `references\u002Fdiagrams\u002Fstate.md` |\n| Project timeline \u002F roadmap | Gantt | `references\u002Fdiagrams\u002Fgantt.md` |\n| Proportions \u002F composition | Pie | `references\u002Fdiagrams\u002Fpie.md` |\n| System architecture (zoom levels) | C4 | `references\u002Fdiagrams\u002Fc4.md` |\n| Concept hierarchy \u002F brainstorm | Mindmap | `references\u002Fdiagrams\u002Fmindmap.md` |\n| Chronological events \u002F history | Timeline | `references\u002Fdiagrams\u002Ftimeline.md` |\n| Class hierarchy \u002F type relationships | Class | `references\u002Fdiagrams\u002Fclass.md` |\n| User journey \u002F satisfaction map | User Journey | `references\u002Fdiagrams\u002Fuser_journey.md` |\n| Two-axis comparison \u002F prioritization | Quadrant | `references\u002Fdiagrams\u002Fquadrant.md` |\n| Requirements traceability | Requirement | `references\u002Fdiagrams\u002Frequirement.md` |\n| Flow magnitude \u002F resource distribution | Sankey | `references\u002Fdiagrams\u002Fsankey.md` |\n| Numeric trends \u002F bar + line charts | XY Chart | `references\u002Fdiagrams\u002Fxy_chart.md` |\n| Component layout \u002F spatial arrangement | Block | `references\u002Fdiagrams\u002Fblock.md` |\n| Work item status \u002F task columns | Kanban | `references\u002Fdiagrams\u002Fkanban.md` |\n| Cloud infrastructure \u002F service topology | Architecture | `references\u002Fdiagrams\u002Farchitecture.md` |\n| Multi-dimensional comparison \u002F skills radar | Radar | `references\u002Fdiagrams\u002Fradar.md` |\n| Hierarchical proportions \u002F budget | Treemap | `references\u002Fdiagrams\u002Ftreemap.md` |\n| Binary protocol \u002F data format | Packet | `references\u002Fdiagrams\u002Fpacket.md` |\n| Git branching \u002F merge strategy | Git Graph | `references\u002Fdiagrams\u002Fgit_graph.md` |\n| Code-style sequence (programming syntax) | ZenUML | `references\u002Fdiagrams\u002Fzenuml.md` |\n| Multi-diagram composition patterns | Complex Examples | `references\u002Fdiagrams\u002Fcomplex_examples.md` |\n\n> 💡 **Pick the right type, not the easy one.** Don't default to flowcharts for everything.\n> A timeline beats a flowchart for chronological events. A sequence beats a flowchart for\n> service interactions. Scan the table and match.\n\n---\n\n## 🔧 Core workflow\n\n### Step 1: Identify the document type\n\nCheck if a template exists before writing from scratch:\n\n| Document type | Template |\n| ------------------------------ | ----------------------------------------------- |\n| Pull request record | `templates\u002Fpull_request.md` |\n| Issue \u002F bug \u002F feature request | `templates\u002Fissue.md` |\n| Sprint \u002F project board | `templates\u002Fkanban.md` |\n| Architecture decision (ADR) | `templates\u002Fdecision_record.md` |\n| Presentation \u002F briefing | `templates\u002Fpresentation.md` |\n| Research paper \u002F analysis | `templates\u002Fresearch_paper.md` |\n| Project documentation | `templates\u002Fproject_documentation.md` |\n| How-to \u002F tutorial | `templates\u002Fhow_to_guide.md` |\n| Status report | `templates\u002Fstatus_report.md` |\n\n### Step 2: Read the style guide\n\nFor this Markdown workflow, read `references\u002Fmarkdown_style_guide.md`. Treat emoji,\nheading counts, and horizontal rules as house style rather than Markdown syntax requirements.\n\nKey rules to internalize:\n\n- **One H1 per document** — the title. Never more.\n- **Emoji on H2 headings only** — one emoji per H2, none in H3\u002FH4\n- **Support factual claims** — use verified sources and the requested citation format\n- **Bold sparingly** — max 2-3 bold terms per paragraph, never full sentences\n- **Optional horizontal rules** after `\u003C\u002Fdetails>` when they improve separation\n- **Tables over prose** for comparisons, configurations, structured data\n- **Diagrams over walls of text** — if it describes flow, structure, or relationships, add Mermaid\n\n### Step 3: Pick the diagram type and read its guide\n\nBefore creating any Mermaid diagram: read `references\u002Fmermaid_style_guide.md`.\n\nThen open the specific type file (e.g., `references\u002Fdiagrams\u002Fflowchart.md`) for the exemplar, tips, and copy-paste template.\n\nAdd accessibility metadata for types that emit it in the chosen renderer:\n\n```\naccTitle: Short Name 3-8 Words\naccDescr: One or two sentences explaining what this diagram shows.\n```\n\n- Prefer host themes; `%%{init}` directives are deprecated in favor of YAML configuration\n- Prefer reusable `classDef` where supported; style syntax is diagram-specific\n- **One emoji per node max** — at the start of the label\n- Use descriptive IDs with the type's syntax: `snake_case` works for flowcharts; ER\u002Fclass\u002Fstate conventions differ\n\n### Step 4: Write the document\n\nStart from the template. Apply the markdown style guide. Place diagrams inline with related text — not in a separate \"Figures\" section.\n\nRender in the **actual destination** before delivery. Check its Mermaid version and\nplugin requirements before choosing newer diagram types; [GitHub documents an `info`\ndiagram for this check](https:\u002F\u002Fdocs.github.com\u002Fen\u002Fget-started\u002Fwriting-on-github\u002Fworking-with-advanced-formatting\u002Fcreating-diagrams).\nA successful latest-version local preview does not establish GitHub or another host\nwill render it. Where Mermaid is unsupported, supply a rendered SVG\u002FPNG with a text\ndescription alongside the retained `.md` source.\n\n### Step 5: Retain source and verification\n\nKeep the `.md` source, rendered deliverable, and tested renderer version together.\nFollow the project's version-control workflow; this skill does not itself authorize a commit or publication.\nFor CLI export, embedding, and the tested accessibility matrix, read\n[Current rendering and validation](references\u002Fcurrent-rendering.md).\n\n---\n\n## ⚠️ Common pitfalls\n\n### Radar chart syntax (`radar-beta`)\n\n**WRONG (shown as text so it does not break the document renderer):**\n```text\nradar\ntitle Example\nx-axis [\"A\", \"B\", \"C\"]\n\"Series\" : [1, 2, 3]\n```\n\n**CORRECT:**\n```mermaid\nradar-beta\naccTitle: Example Radar Scores\naccDescr: Illustrative values of one, two, and three on a shared zero-to-three scale.\ntitle Example\naxis a[\"A\"], b[\"B\"], c[\"C\"]\ncurve series[\"Series\"]{1, 2, 3}\nmax 3\n```\n\n- **Use `radar-beta`** not `radar` (the bare keyword doesn't exist)\n- **Use `axis`** to define dimensions, **not** `x-axis`\n- **Use `curve`** to define data series, **not** quoted labels with colon\n- Mermaid 12.0.0 radar emits `accTitle`\u002F`accDescr`; check older hosts and retain a visible description\n\n### XY Chart vs Radar confusion\n\n| Diagram | Keyword | Axis syntax | Data syntax |\n| ------- | ------- | ----------- | ----------- |\n| **XY Chart** (bars\u002Flines) | `xychart-beta` | `x-axis [\"Label1\", \"Label2\"]` | `bar [10, 20]` or `line [10, 20]` |\n| **Radar** (spider\u002Fweb) | `radar-beta` | `axis id[\"Label\"]` | `curve id[\"Label\"]{10, 20}` |\n\n### Forgetting `accTitle`\u002F`accDescr` on supported types\n\nOnly some diagram types support `accTitle`\u002F`accDescr`. For those that don't, always place a descriptive italic paragraph directly above the code block:\n\n> _Radar chart comparing three methods on a stated, common score scale. See the data table for exact values._\n\n```text\nradar-beta\n...\n```\n\n---\n\n## 🔗 Integration with other skills\n\n### With `scientific-schematics`\n\n`scientific-schematics` generates AI-powered publication-quality images (PNG). Use the Mermaid diagram as the **brief** for the schematic:\n\n```\nWorkflow:\n1. Create the concept as Mermaid in .md (this skill — Phase 1)\n2. Describe the same concept to scientific-schematics for a polished PNG (Phase 3)\n3. Commit both — the .md as source, the PNG as a supplementary figure\n```\n\n### With `scientific-writing`\n\nFor a manuscript that uses Mermaid structural figures, this skill handles diagram syntax.\nFollow the manuscript's required figure formats and scientific visualization conventions.\n\n```\nWorkflow:\n1. Use scientific-writing to draft the manuscript\n2. For every figure that shows a workflow, architecture, or relationship:\n   - Replace placeholder with a Mermaid diagram following this skill's guide\n3. Use plotting or schematic tools where appropriate to the scientific content\n```\n\n### With `literature-review`\n\nLiterature review produces summaries with lots of relationship data. Use this skill to:\n\n- Create concept maps (Mindmap) of the literature landscape\n- Show publication timelines (Timeline or Gantt)\n- Compare methodologies (Quadrant or Radar)\n- Diagram data flows described in papers (Sequence or Flowchart)\n\n### With any skill that produces output documents\n\nBefore finalizing a document using this skill, check:\n\n- [ ] Does the document use a template? If so, did I start from the right one?\n- [ ] Is each diagram in an appropriate format, with working accessibility metadata or a text alternative?\n- [ ] Is configuration supported by the destination and tested in light\u002Fdark themes?\n- [ ] Do citations support external claims, and are synthetic values labeled?\n- [ ] One H1, emoji on H2 only?\n- [ ] Does the final Markdown\u002FHTML structure render correctly?\n\n---\n\n## 📚 Reference index\n\n### Style guides\n\n| Guide | Path | Lines | What it covers |\n| ----------------------- | ------------------------------------------- | ----- | -------------------------------------------------- |\n| Markdown Style Guide | `references\u002Fmarkdown_style_guide.md` | see file | Headings, formatting, citations, tables, Mermaid integration, templates, quality checklist |\n| Mermaid Style Guide | `references\u002Fmermaid_style_guide.md` | see file | Accessibility, emoji set, color classes, theme neutrality, type selection, complexity tiers |\n| Current Rendering | `references\u002Fcurrent-rendering.md` | see file | Mermaid 12 changes, CLI export, browser APIs, tested accessibility matrix, scientific checks |\n\n### Diagram guides (23 types plus composition)\n\nEach file contains: production-quality exemplar, tips specific to that type, and a copy-paste template.\n\n`references\u002Fdiagrams\u002F` — architecture, block, c4, class, complex\\_examples, er, flowchart, gantt, git\\_graph, kanban, mindmap, packet, pie, quadrant, radar, requirement, sankey, sequence, state, timeline, treemap, user\\_journey, xy\\_chart, zenuml\n\n### Document templates (9 types)\n\n`templates\u002F` — decision\\_record, how\\_to\\_guide, issue, kanban, presentation, project\\_documentation, pull\\_request, research\\_paper, status\\_report\n\n### Examples\n\n`assets\u002Fexamples\u002Fexample-research-report.md` — a synthetic quality-control report with explicitly invented data, an auditable count table, a structural flowchart, a bar chart, and a chronology. It makes no experimental or software API claims.\n\n---\n\n## 📝 Attribution\n\nAll style guides, diagram type guides, and document templates in this skill are ported from the `SuperiorByteWorks-LLC\u002Fagent-project` repository under the Apache-2.0 License.\n\n- **Source**: https:\u002F\u002Fgithub.com\u002FSuperiorByteWorks-LLC\u002Fagent-project\n- **Author**: Clayton Young \u002F Superior Byte Works, LLC (@borealBytes)\n- **License**: Apache-2.0\n\nThis skill (as part of scientific-agent-skills) is distributed under the MIT License. The included Apache-2.0 content is compatible for downstream use with attribution retained, as preserved in the file headers throughout this skill.\n\n---\n\n[^1]: GitHub Blog. (2022). \"Include diagrams in your Markdown files with Mermaid.\" https:\u002F\u002Fgithub.blog\u002F2022-02-14-include-diagrams-markdown-files-mermaid\u002F\n\n[^2]: Mermaid. \"Mermaid Diagramming and Charting Tool.\" https:\u002F\u002Fmermaid.js.org\u002F\n",{"name":5,"license":15,"metadata":24,"description":7,"allowed-tools":32,"compatibility":33},{"version":25,"skill-author":26,"skill-source":27,"last-reviewed":28,"skill-version":29,"mermaid-tested":30,"mermaid-cli-tested":30,"skill-contributors":31},"1.3","Clayton Young \u002F Superior Byte Works, LLC (@borealBytes)","https:\u002F\u002Fgithub.com\u002FSuperiorByteWorks-LLC\u002Fagent-project","2026-10-01","1.0.0","12.0.0","Clayton Young (Superior Byte Works, LLC \u002F @borealBytes; Author and originator); K-Dense Team (K-Dense Inc.; Integration target and community feedback)","Read Write Edit Bash","Markdown authoring needs no runtime. Local rendering targets Mermaid and Mermaid CLI 12.0.0, Node.js 22.13+ and a supported Chromium browser. Package or CDN installation needs network access; no credentials required.","master","fd76f882a04e445e899d5cfb2732f2105ea054ee","skills\u002Fawesome-skills\u002Fmarkdown-mermaid-writing",0,"https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS","https:\u002F\u002Fbg-szy.github.io\u002FTOP-SKILLS\u002F","https:\u002F\u002Fgithub.com\u002Fbg-szy","https:\u002F\u002Fwww.ecust.edu.cn\u002F","a student of East China University of Science and Technology","2026-11-12 05:55:03",{"source":8,"skillName":5,"commands":45,"prompt":55,"zipAvailable":56},[46,49,52],{"tool":47,"command":48},"npx","npx skills add bg-szy\u002FTOP-SKILLS --skill markdown-mermaid-writing",{"tool":50,"command":51},"bunx","bunx skills add bg-szy\u002FTOP-SKILLS --skill markdown-mermaid-writing",{"tool":53,"command":54},"pnpm","pnpm dlx skills add bg-szy\u002FTOP-SKILLS --skill markdown-mermaid-writing","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fawesome-skills\u002Fmarkdown-mermaid-writing\u002FSKILL.md",true,[],[59,68,76,84,92,99],{"skillNo":60,"name":61,"nameZh":6,"description":62,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":63,"licenseFileUrl":64,"sourceHtmlUrl":65,"categories":66,"keywords":67,"publishedAt":19},"01M73WM4TPHEJ57D7G2AZ0ABVT","inbox-guardian-for-gmail","Review a personal Gmail inbox with local, owner-approved spam rules. Use for audit-first quarantine, Trash, repeated-evidence sender learning, and header review. Do not use for automatic unsubscribe requests or unreviewed mailbox actions.","MIT","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fmarketplace\u002Finbox-guardian-for-gmail\u002FLICENSE","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fmarketplace\u002Finbox-guardian-for-gmail\u002FSKILL.md",[],[],{"skillNo":69,"name":70,"nameZh":6,"description":71,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":72,"licenseFileUrl":6,"sourceHtmlUrl":73,"categories":74,"keywords":75,"publishedAt":19},"01M73QERWCH2YEGTPC346PKGWW","chatgpt-app-builder","Guide developers through creating and updating ChatGPT apps.\nCovers the full lifecycle: brainstorming ideas against UX guidelines, bootstrapping projects, implementing tools\u002Fviews, debugging, running dev servers, deploying and connecting apps to ChatGPT.\nUse when a user wants to create or update a ChatGPT app \u002F MCP server for ChatGPT, or use the Skybridge framework.","NOASSERTION","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fmarketplace\u002Fchatgpt-app-builder\u002FSKILL.md",[],[],{"skillNo":77,"name":78,"nameZh":6,"description":79,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":63,"licenseFileUrl":80,"sourceHtmlUrl":81,"categories":82,"keywords":83,"publishedAt":19},"01M73PZFMKXPVJQCV7T0BBV6EV","brewpage-publish","Publish content to brewpage.app — text, markdown, JSON, file, or multi-file site. Asks namespace and password, returns public URL. Triggers: publish, share link, upload to brewpage, host page, brewpage, publish site, upload site, upload directory, deploy site, сделай публичную ссылку, опубликуй.","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fmarketplace\u002Fbrewpage-publish\u002FLICENSE","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fmarketplace\u002Fbrewpage-publish\u002FSKILL.md",[],[],{"skillNo":85,"name":86,"nameZh":6,"description":87,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":88,"licenseFileUrl":6,"sourceHtmlUrl":89,"categories":90,"keywords":91,"publishedAt":19},"01M73KATEQ37JEDHHGKYHSZK40","zinc-database","Query the ZINC22 virtual compound library (CartBlanche API, billions of make-on-demand + purchasable molecules). Look up substances by ZINC ID, resolve a SMILES to its ZINC ID (exact match), inspect purchasability\u002Fcatalogs, and assemble compound sets for docking. Property (MW\u002FlogP) filtering is done locally with RDKit. For bioactivity use chembl-database-bioactivity; for approved drugs use drugbank-database-access.","CC-BY-4.0","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fawesome-skills\u002Fzinc-database\u002FSKILL.md",[],[],{"skillNo":93,"name":94,"nameZh":6,"description":95,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":63,"licenseFileUrl":6,"sourceHtmlUrl":96,"categories":97,"keywords":98,"publishedAt":19},"01M73KAN6B77H0VZ0J0P4XX5M7","zarr-python","Stores and queries chunked N-D scientific arrays with Zarr-Python 3, including codecs, sharding, S3\u002FGCS storage, and NumPy\u002FDask\u002FXarray integration. Use for array layout, bounded I\u002FO, format migration, or scientific metadata preservation.","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fawesome-skills\u002Fzarr-python\u002FSKILL.md",[],[],{"skillNo":100,"name":101,"nameZh":6,"description":102,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":63,"licenseFileUrl":6,"sourceHtmlUrl":103,"categories":104,"keywords":105,"publishedAt":19},"01M73K8904EZK0FDY5Z9A5NQ47","waypoint-bio","Supports work with Outpost Bio's open microbiome foundation models - the Waypoint checkpoints (Waypoint-6m, Waypoint-45m, Waypoint-170m), the Atlas pretraining corpus, the Compass eight-task benchmark, or the `waypoint` CLI from the `waypoint-bio` package. Covers embedding microbiome samples, fine-tuning on taxonomic abundance data, benchmarking a checkpoint on Compass, pretraining a GPT-2 model on taxonomic abundance profiles, and converting MetaPhlAn, Kraken2, QIIME 2, or MGnify abundance tables into waypoint format.","https:\u002F\u002Fgithub.com\u002Fbg-szy\u002FTOP-SKILLS\u002Fblob\u002Fmaster\u002Fskills\u002Fawesome-skills\u002Fwaypoint-bio\u002FSKILL.md",[],[]]