Markdown Mermaid Writing

What it does

When your agent uses it

• A user requests Markdown
• A text-based structural diagram
• Quantitative scientific figures require suitable plotting tools

Example prompts

• “Use the markdown-mermaid-writing skill to write scientific Markdown documentation and Mermaid diagrams for workflows, relationships, timelines, and…”
• “/markdown-mermaid-writing”

Requirements

• Python 3
• Node.js
• Compatibility (from SKILL.md): 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.
• Pre-approved tools (allowed-tools): Read, Write, Edit, Bash

Workflow steps

5 steps, taken from the step headings in SKILL.md.

1. 1Identify the document type
2. 2Read the style guide
3. 3Pick the diagram type and read its guide
4. 4Write the document
5. 5Retain source and verification

What it can do on your machine

Read from SKILL.md and the folder at commit 92ace75. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves these tools, so the agent can use them without asking each time:

  • Read
  • Write
  • Edit
  • Bash

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  No scripts in the folder and no shell commands in SKILL.md (its code samples are mermaid).

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Links to these hosts (documentation or services it may open):

  • docs.github.com
  • github.com
  • github.blog
  • mermaid.js.org

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  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.

  From compatibility in the SKILL.md frontmatter.

Context cost

Markdown Mermaid Writing loads about 4.2k tokens when it runs, and up to ~51k if it reads all its reference files. Until then it costs about 98 tokens; SKILL.md has 1,506 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~98

When it runs · the whole SKILL.md, loaded when a task matches

~4.2k

With references · SKILL.md plus every file in references/, read only if the agent opens them

~51k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

• NotePre-approves every shell command (allowed-tools: Bash)SKILL.md

  allowed-tools: Read, Write, Edit, Bash

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from K-Dense-AI/scientific-agent-skills at commit 92ace75, republished under its Apache-2.0 licence (© K-Dense-AI). 1,506 words, ~4,157 tokens.

name

markdown-mermaid-writing

description

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.

allowed-tools

Read, Write, Edit, Bash

compatibility

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.

license

Apache-2.0

metadata.version

1.3

metadata.last-reviewed

2026-10-01

metadata.mermaid-tested

12.0.0

metadata.mermaid-cli-tested

12.0.0

metadata.skill-author

Clayton Young / Superior Byte Works, LLC (@borealBytes)

metadata.skill-source

https://github.com/SuperiorByteWorks-LLC/agent-project

metadata.skill-version

1.0.0

metadata.skill-contributors

Clayton Young (Superior Byte Works, LLC / @borealBytes; Author and originator); K-Dense Team (K-Dense Inc.; Integration target and community feedback)

flowchart LR
    accTitle: Three-Phase Documentation Workflow
    accDescr: Markdown holds the structural diagram source. Quantitative charts come from data and plotting code; optional illustrations require a separate factual review.

    p1["📄 Phase 1<br/>Mermaid in Markdown<br/>(structural source)"]
    p2["🐍 Phase 2<br/>Python Generated<br/>(optional — data charts)"]
    p3["🎨 Phase 3<br/>AI Generated Visuals<br/>(optional — polish)"]
    out["📊 Final Deliverable"]

    p1 --> out
    data["Data and plotting code"] --> p2
    p1 -.->|"when needed"| p3
    p2 --> out
    p3 --> out

    classDef required fill:#dbeafe,stroke:#2563eb,stroke-width:2px,color:#1e3a5f
    classDef optional fill:#fef9c3,stroke:#ca8a04,stroke-width:2px,color:#713f12
    classDef output fill:#dcfce7,stroke:#16a34a,stroke-width:2px,color:#14532d

    class p1 required
    class p2,p3 optional
    class out output

accTitle: Short Name 3-8 Words
accDescr: One or two sentences explaining what this diagram shows.

radar
title Example
x-axis ["A", "B", "C"]
"Series" : [1, 2, 3]

radar-beta
accTitle: Example Radar Scores
accDescr: Illustrative values of one, two, and three on a shared zero-to-three scale.
title Example
axis a["A"], b["B"], c["C"]
curve series["Series"]{1, 2, 3}
max 3

radar-beta
...

Workflow:
1. Create the concept as Mermaid in .md (this skill — Phase 1)
2. Describe the same concept to scientific-schematics for a polished PNG (Phase 3)
3. Commit both — the .md as source, the PNG as a supplementary figure

Workflow:
1. Use scientific-writing to draft the manuscript
2. For every figure that shows a workflow, architecture, or relationship:
   - Replace placeholder with a Mermaid diagram following this skill's guide
3. Use plotting or schematic tools where appropriate to the scientific content

© K-Dense-AI, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 38 other files (references, assets) in skills/markdown-mermaid-writing of K-Dense-AI/scientific-agent-skills.

• SKILL.md
• 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
• references/diagrams/pie.md
• references/diagrams/quadrant.md
• … and 22 more

Open the folder on GitHubat commit 92ace75

Used in 1 other repository

We found 1 copy of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in K-Dense-AI/scientific-agent-skills, which our catalogue first saw on October 7, 2026.

• lingxling/awesome-skills-cnclaude-scientific-skills/skills/markdown-mermaid-writing