|
| 1 | +[English](README.md) | [中文](README_zh.md) |
| 2 | + |
| 3 | +# Obsidian Mind Map |
| 4 | + |
| 5 | +An intuitive mind map plugin for Obsidian that transforms your markdown documents into interactive mind maps using [Mind Elixir](https://github.com/ssshooter/mind-elixir-core). |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +### Mind Map View |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +- **Open as Mind Map**: Transform any markdown file into an interactive mind map view |
| 14 | +- **Smart Parsing**: Automatically parses markdown headers and lists into hierarchical mind map nodes |
| 15 | +- **Split View**: Opens mind maps in a split pane while preserving your original document |
| 16 | +- **Auto-Refresh**: Mind map updates automatically when the source file changes |
| 17 | +- **Customizable Root**: Choose between using the filename or the first H1 heading as the root node |
| 18 | + |
| 19 | +### Code Block Rendering |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | +- **Inline Mind Maps**: Embed mind maps directly in your notes using `mindelixir` code blocks |
| 24 | +- **Plain Text Format**: Use simple indented text format for quick mind map creation |
| 25 | +- **Non-Intrusive**: Mind maps render seamlessly within your markdown content |
| 26 | + |
| 27 | +### Mobile Support |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +- **Works on Mobile**: Fully functional on Obsidian's mobile app, allowing you to view and interact with mind maps on the go |
| 32 | + |
| 33 | +## Usage |
| 34 | + |
| 35 | +### Method 1: Mind Map View |
| 36 | + |
| 37 | +1. Open any markdown file in Obsidian |
| 38 | +2. Click the mind map icon in the ribbon, or |
| 39 | +3. Use the command palette: `Mind Map: Open as Mind Map` |
| 40 | +4. Your markdown content will open as an interactive mind map in a split pane |
| 41 | + |
| 42 | +### Method 2: Code Blocks |
| 43 | + |
| 44 | +Create inline mind maps using the `mindelixir` code block: |
| 45 | + |
| 46 | +````markdown |
| 47 | +```mindelixir |
| 48 | +Root Topic |
| 49 | + Subtopic 1 |
| 50 | + Detail 1 |
| 51 | + Detail 2 |
| 52 | + Subtopic 2 |
| 53 | + Detail 3 |
| 54 | +``` |
| 55 | +```` |
| 56 | + |
| 57 | +For the specific format specification, please refer to the [Mind Elixir Plain Text Format Reference](https://github.com/SSShooter/mind-elixir-core/blob/master/skills/plaintext-format/SKILL.md). |
| 58 | + |
| 59 | +## Settings |
| 60 | + |
| 61 | +- **Use first H1 as root**: When enabled, uses the first H1 heading as the root node instead of the filename. Content before the first H1 will be ignored. |
| 62 | + |
| 63 | +## Manually installing the plugin |
| 64 | + |
| 65 | +- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. |
| 66 | + |
| 67 | +## TODO |
| 68 | + |
| 69 | +- Support node copy and paste |
| 70 | +- Support reverse edit in `mindelixir` code block |
| 71 | +- Record links delta if modified |
| 72 | +- Support image in mind map |
0 commit comments