Obsidian Mermaid logo

Obsidian Mermaid

Community
jykim
obsidian-mermaid

Create Obsidian-compatible Mermaid diagrams. Prefer square layouts (TB + subgraph LR), avoid markdown in labels. Use when creating flowcharts, sequence diagrams, or any Mermaid diagrams in markdown files.

Overview

Publisherjykim
Repositoryclaude-obsidian-skills
Skill nameobsidian-mermaid
Stars
52
Forks
10
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by jykim on GitHub. Read the source before you install it.

Installation

Install the Obsidian Mermaid AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/jykim/claude-obsidian-skills/tree/main/obsidian-mermaid
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/jykim/claude-obsidian-skills.git /tmp/claude-obsidian-skills
mkdir -p .claude/skills
cp -r /tmp/claude-obsidian-skills/obsidian-mermaid .claude/skills/obsidian-mermaid
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Obsidian Mermaid in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Obsidian Mermaid on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Obsidian Mermaid is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Obsidian Mermaid Diagrams

Create Mermaid diagrams that render correctly in Obsidian and publish without issues.

When to Use This Skill

Activate when you need to:

  • Create flowcharts, sequence diagrams, ER diagrams
  • Convert ASCII art to Mermaid
  • Fix Mermaid rendering errors in Obsidian

Core Principle: Simplicity First

다이어그램은 한눈에 들어와야 한다

복잡한 다이어그램은 읽기 어렵다. 항상 최소한의 노드와 연결로 핵심만 표현하라.

Node Minimization

Before (9개 노드):

After (2개 노드 - 순차 흐름을 노드 내 텍스트로):

Connection Minimization

  • 핵심 흐름만 표현, 세부사항은 본문에서 설명
  • 노드 5개 이하, 연결선 교차 금지
  • 복잡한 관계는 여러 개의 단순한 다이어그램으로 분리

Table vs Mermaid 선택

형식용도예시
테이블속성-값 매핑, 비교, 옵션에너지 레벨별 작업
Mermaid흐름, 프로세스, 피드백 루프입력→처리→출력
인라인단순 순차 흐름A → B → C

원칙: 같은 정보를 더 컴팩트하게 표현하는 형식 선택


Critical Rules

1. NO Markdown in Labels

Common Errors:

Node["1. First"]     → "Unsupported markdown: list"
Node["Text<br/>More"] → "Unsupported markdown: heading"
Node["## Header"]    → "Unsupported markdown: heading"

Correct:

Node[First]
Node[Text]

Rule: Keep labels plain text. Move complex descriptions outside the diagram.

2. Prefer Square Layout (정사각형 레이아웃)

Problem: flowchart LR은 너무 넓고, flowchart TB는 너무 길어진다.

Solution: TB + 내부 LR 조합으로 정사각형에 가까운 레이아웃 만들기

패턴:

  • flowchart TB: 전체 흐름은 위→아래
  • direction LR: 각 subgraph 내부는 가로 배치
  • ~~~: 보이지 않는 연결 (화살표 없이 정렬용)

Rule: 세로로 너무 길어지면 subgraph + direction LR 사용.

3. Keep Labels Short

markdown
❌ Too long:
Node["This is a very long description that will break layout"]

✅ Short and clear:
Node[Short Label]

Rule: Labels should be under 15 characters. Add details in text below the diagram.

4. Avoid Special Characters in Subgraph Names

markdown
❌ May cause issues:
subgraph "1. Phase One"
subgraph "Phase: Setup"

✅ Safe:
subgraph Phase_One["Phase One"]
subgraph Setup["Setup Phase"]

Good Examples

Simple Flowchart

Process Flow with Details Outside

Process Details:

  • Input: User data from form
  • Process: Validation and transformation
  • Output: Saved to database

Subgraph Example

Bad Examples (Don't Do This)

Markdown in Labels

This will show "Unsupported markdown" errors.

Too Wide

This gets cut off on mobile and narrow screens.

Converting ASCII to Mermaid

ASCII Art:

┌───────┐     ┌───────┐
│ Start │────→│  End  │
└───────┘     └───────┘

Mermaid:

Quality Checklist

Before completing diagram creation:

  • No <br/> tags in node labels
  • No numbered list format (1., 2.) in labels
  • 정사각형 레이아웃: TB + subgraph 내 LR 조합 사용
  • All labels are short (under 15 characters)
  • Complex details moved to text outside diagram
  • No special characters in subgraph names
  • Tested rendering in Obsidian preview

Frequently asked questions

What does the Obsidian Mermaid AI skill do?

Create Obsidian-compatible Mermaid diagrams. Prefer square layouts (TB + subgraph LR), avoid markdown in labels. Use when creating flowcharts, sequence diagrams, or any Mermaid diagrams in markdown files.

Why use Obsidian Mermaid on TypingMind?

Because you install it once and use it with any model. Obsidian Mermaid is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Obsidian Mermaid in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/jykim/claude-obsidian-skills/tree/main/obsidian-mermaid. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Obsidian Mermaid?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Obsidian Mermaid?

As many as you like. As long as a model supports skills, you can use Obsidian Mermaid with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Obsidian Mermaid AI skill free?

Yes. It is published on GitHub by jykim under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇