Skip to content

Conversation

@blueholes
Copy link

Mermaid Enhanced - Obsidian Plugin

An enhanced Mermaid chart tool plugin that provides convenient Mermaid chart creation and editing features for Obsidian.

Features

  • 🎨 Rich Template Library - Built-in various commonly used chart templates (flowcharts, sequence diagrams, Gantt charts, class diagrams, etc.)
  • Quick Insertion - One-click insertion of commonly used chart templates
  • ✏️ Visual Editor - Provides a code editor with real-time preview of Mermaid charts
  • 🎯 Command Palette Integration - Quickly access all features through the command palette
  • ⚙️ Configurable Settings - Customize themes and feature toggles

Installation Method

Manual Installation

  1. Copy the entire plugin folder to the .obsidian/plugins/ directory of your Obsidian vault
  2. Open settings in Obsidian → Third-party plugins
  3. Find "Mermaid Enhanced" and enable it

Usage

Command Palette

Press Ctrl+P (Windows/Linux) or Cmd+P (Mac) to open the command palette, then type:

  • Insert Mermaid Chart - Insert a basic Mermaid chart code block
  • Open Mermaid Template Library - Browse and insert various chart templates
  • Open Mermaid Editor - Use the visual editor to create and edit charts
  • Insert Flowchart Template - Quickly insert a flowchart template
  • Insert Sequence Diagram Template - Quickly insert a sequence diagram template
  • Insert Gantt Chart Template - Quickly insert a Gantt chart template

Template Library

  1. Click the icon in the left sidebar or use the command palette to open the template library
  2. Browse templates in different categories
  3. Click the "Insert" button to insert the template at the current cursor position

Editor

  1. Use the command palette to open the Mermaid editor
  2. Enter or modify Mermaid code in the editor
  3. Click "Insert into Note" to insert the code into the current document

Supported Chart Types

  • Flowchart
  • Sequence Diagram
  • Gantt Chart
  • Class Diagram
  • State Diagram
  • Pie Chart
  • Entity Relationship Diagram
  • User Journey
  • Quadrant Chart

Settings Options

In Obsidian settings, you can configure:

  • Enable Template Library - Turn the template library feature on/off
  • Quick Insertion - Turn the quick insertion feature on/off
  • Mermaid Theme - Choose the theme style for charts (default, dark, forest, neutral)

Please switch to Preview and select one of the following links:

# Mermaid Enhanced - Obsidian Plugin

An enhanced Mermaid chart tool plugin that provides convenient Mermaid chart creation and editing features for Obsidian.

## Features

- 🎨 **Rich Template Library** - Built-in various commonly used chart templates (flowcharts, sequence diagrams, Gantt charts, class diagrams, etc.)
- ⚡ **Quick Insertion** - One-click insertion of commonly used chart templates
- ✏️ **Visual Editor** - Provides a code editor with real-time preview of Mermaid charts
- 🎯 **Command Palette Integration** - Quickly access all features through the command palette
- ⚙️ **Configurable Settings** - Customize themes and feature toggles

## Installation Method

### Manual Installation

1. Copy the entire plugin folder to the `.obsidian/plugins/` directory of your Obsidian vault
2. Open settings in Obsidian → Third-party plugins
3. Find "Mermaid Enhanced" and enable it


## Usage

### Command Palette

Press `Ctrl+P` (Windows/Linux) or `Cmd+P` (Mac) to open the command palette, then type:

- **Insert Mermaid Chart** - Insert a basic Mermaid chart code block
- **Open Mermaid Template Library** - Browse and insert various chart templates
- **Open Mermaid Editor** - Use the visual editor to create and edit charts
- **Insert Flowchart Template** - Quickly insert a flowchart template
- **Insert Sequence Diagram Template** - Quickly insert a sequence diagram template
- **Insert Gantt Chart Template** - Quickly insert a Gantt chart template

### Template Library

1. Click the icon in the left sidebar or use the command palette to open the template library
2. Browse templates in different categories
3. Click the "Insert" button to insert the template at the current cursor position

### Editor

1. Use the command palette to open the Mermaid editor
2. Enter or modify Mermaid code in the editor
3. Click "Insert into Note" to insert the code into the current document

## Supported Chart Types

- Flowchart
- Sequence Diagram
- Gantt Chart
- Class Diagram
- State Diagram
- Pie Chart
- Entity Relationship Diagram
- User Journey
- Quadrant Chart

## Settings Options

In Obsidian settings, you can configure:

- **Enable Template Library** - Turn the template library feature on/off
- **Quick Insertion** - Turn the quick insertion feature on/off
- **Mermaid Theme** - Choose the theme style for charts (default, dark, forest, neutral)
@github-actions
Copy link

github-actions bot commented Nov 9, 2025

Hello!

I found the following issues in your plugin submission

Errors:

❌ You did not follow the pull request template. The PR template can be found here
❌ Description mismatch, the description in this PR (Mermaid chart tool, supporting quick generation and editing of Mermaid charts.) is not the same as the one in your repo (Mermaid chart tool, supporting quick generation and editing of Mermaid charts). If you just changed it, remember to change it in the manifest.json in your repo and your latest GitHub release.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant