explaingit

qiaoborui/obsidian-beautiful-mermaid

Analysis updated 2026-05-18

1TypeScriptAudience · generalComplexity · 1/5Setup · easy

TLDR

An Obsidian plugin that renders Mermaid diagrams in your notes as polished, theme-matching SVG images instead of plain text.

Mindmap

mindmap
  root((beautiful-mermaid))
    What it does
      Renders Mermaid as SVG
      Matches theme colors
      Edit and preview
    Tech stack
      TypeScript
      bun
    Use cases
      Prettier diagrams
      Theme-aware notes
      Flowcharts and charts
    Audience
      Obsidian users
      Note-takers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Render Mermaid flowcharts and charts in Obsidian as polished SVGs that match your current theme.

USE CASE 2

Tag a code block as mermaid-beautiful or bmmd to get styled diagrams instead of the default renderer.

USE CASE 3

Toggle between fitting diagrams to the editor width or scrolling horizontally at natural size.

What is it built with?

TypeScriptbun

How does it compare?

qiaoborui/obsidian-beautiful-mermaid0xkinno/neuralvault0xmayurrr/ai-contractauditor
Stars111
LanguageTypeScriptTypeScriptTypeScript
Setup difficultyeasyhardeasy
Complexity1/54/52/5
Audiencegeneraldeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Installation is manual: copy three built files into your Obsidian vault's plugins folder.

In plain English

Obsidian is a popular note-taking application where users write notes in Markdown format. Mermaid is a syntax for creating diagrams, flowcharts, charts, and more, using plain text inside a code block. This plugin upgrades how Mermaid diagrams look inside Obsidian by rendering them using the "beautiful-mermaid" library, which produces polished SVG diagrams that automatically adapt to your current Obsidian theme's colors. To use it, you write a standard Mermaid diagram inside a code block in your notes, tagged as mermaid, mermaid-beautiful, beautiful-mermaid, or the shorthand bmmd. The plugin intercepts that block and renders it as a styled SVG image. In Obsidian's Live Preview editing mode, the diagram appears once you move the cursor away from the code block, and you can click an Edit button to jump back into the source. Both Live Preview and the separate Reading view are supported. The plugin can render several diagram types including flowcharts, XY bar charts, combined bar and line charts, and horizontal charts, and all of them pick up the current Obsidian theme's color variables so they look consistent with your workspace. Installation is manual: copy three files, main.js, manifest.json, and styles.css, into a designated folder inside your Obsidian vault, then enable the plugin in Obsidian's settings. A "Fit diagrams to width" setting controls whether diagrams scale to fill the editor or retain their natural height with horizontal scrolling. The plugin is written in TypeScript and built using the bun toolkit.

Copy-paste prompts

Prompt 1
Show me how to manually install this Obsidian plugin by copying main.js, manifest.json, and styles.css.
Prompt 2
Write a Mermaid flowchart code block tagged bmmd for use with this plugin.
Prompt 3
Explain the difference between how this plugin renders diagrams in Live Preview versus Reading view.
Prompt 4
How do I enable the 'Fit diagrams to width' setting in this plugin?

Frequently asked questions

What is obsidian-beautiful-mermaid?

An Obsidian plugin that renders Mermaid diagrams in your notes as polished, theme-matching SVG images instead of plain text.

What language is obsidian-beautiful-mermaid written in?

Mainly TypeScript. The stack also includes TypeScript, bun.

How hard is obsidian-beautiful-mermaid to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is obsidian-beautiful-mermaid for?

Mainly general.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.