Mermaid Workflow Skill for Openclaw

A technical automation suite for generating, rendering, and embedding Mermaid diagrams into Markdown documentation via a structured script-based workflow.

runmanfm-bit
v1.0.0
Mar 2, 2026
0
1.1k
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install mermaid-workflow-skill

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install mermaid-workflow-skill using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is Mermaid Workflow Skill?

The Mermaid Workflow Skill provides a professional-grade toolset for developers to manage technical visualizations as code. By utilizing these Openclaw Skills, you can automate the creation of high-quality diagrams including system architectures, roadmaps, and flowcharts without leaving your development environment. This skill bridges the gap between text-based diagram definitions and polished visual assets integrated directly into your project documentation.

At its core, the skill manages the transition from .mmd definition files to high-resolution PNG images using the Mermaid CLI, ensuring that your documentation remains synchronized with your technical designs. It is particularly effective for teams looking to maintain architectural integrity through version-controlled diagramming scripts.

Mermaid Workflow Skill Use Cases

  • Automating the generation of technical roadmaps and project timelines.
  • Creating and updating system architecture diagrams in design documents.
  • Generating sequence diagrams for API documentation and workflow analysis.
  • Visualizing database structures with entity-relationship (ER) diagrams.
  • Integrating automated visual asset generation into CI/CD documentation pipelines.

How Mermaid Workflow Skill Works

  1. Create a Mermaid definition file (.mmd) using the provided Python scripts or pre-defined templates.
  2. Invoke the Mermaid CLI (mmdc) through the conversion script to render the text definition into a PNG image.
  3. Run the insertion script to automatically embed the resulting image into a specific Markdown file, replacing placeholders or appending to sections.
  4. Leverage Openclaw Skills to trigger these steps programmatically during an agent-led development session.

Mermaid Workflow Skill Setup

1. Install Mermaid CLI

Install the required CLI tool globally via npm:

npm install -g @mermaid-js/mermaid-cli

2. Verify Installation

Ensure the mmdc command is accessible in your environment:

mmdc --version

3. Configure Puppeteer

To avoid sandbox issues in various environments, create a puppeteer-config.json file:

{
  "args": ["--no-sandbox", "--disable-setuid-sandbox"]
}

Mermaid Workflow Skill Data Schema & Taxonomy

The skill organizes data through a dedicated directory structure and specific file types:

Component Description
scripts/ Python scripts for creation, conversion, and Markdown insertion.
templates/ Reusable Mermaid templates for various chart types (Roadmap, Architecture, etc.).
examples/ Reference files showing the end-to-end output of the workflow.
.mmd The source text files containing Mermaid syntax definitions.
.png The rendered image assets generated from the source definitions.

Mermaid Workflow Skill Advanced Features

  • Support for 8 specialized Mermaid types including Gantt charts, class diagrams, and state charts.
  • Theme customization supporting default, forest, dark, and neutral styles.
  • Automated placeholder replacement for dynamic image insertion in Markdown files.
  • High-resolution scaling options and custom DPI settings for print-quality diagrams.
  • Sandbox-compliant rendering for secure or headless server environments.
  • Batch processing scripts for converting entire directories of diagram definitions.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*