Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lynchjames/obsidian-mind-map
An Obsidian plugin for displaying markdown notes as mind maps using Markmap.
https://github.com/lynchjames/obsidian-mind-map
obsidian-plugin
Last synced: about 2 months ago
JSON representation
An Obsidian plugin for displaying markdown notes as mind maps using Markmap.
- Host: GitHub
- URL: https://github.com/lynchjames/obsidian-mind-map
- Owner: lynchjames
- License: mit
- Created: 2020-12-06T01:07:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-25T07:02:39.000Z (7 months ago)
- Last Synced: 2024-06-10T11:47:20.162Z (3 months ago)
- Topics: obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 652 KB
- Stars: 1,039
- Watchers: 19
- Forks: 71
- Open Issues: 98
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian-plugins - Mind map - An Obsidian plugin for displaying markdown notes as mind maps using Markmap. (Uncategorized / Uncategorized)
- jimsghstars - lynchjames/obsidian-mind-map - An Obsidian plugin for displaying markdown notes as mind maps using Markmap. (TypeScript)
README
# Obsidian Mind Map
 
This repository contains a plugin for [Obsidian](https://obsidian.md/) for viewing Markdown notes as Mind Maps using [Markmap](https://markmap.js.org/).
A similar plugin is available for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=gera2ld.markmap-vscode).
## Features
- Preview your current note as a Mind Map
- Mind Map preview updates as you select other panes, similar to the [Local Graph](https://forum.obsidian.md/t/how-to-open-a-local-graph-view-pane-on-the-right-sidebar/7190), [Outline](https://publish.obsidian.md/help/Plugins/Outline) and [Backlink](https://publish.obsidian.md/help/Plugins/Backlinks) panes
## Usage
You can open the Mind Map preview for the current note with a command.
### Preview More Options Menu
The Mind Map Preview view has 2 options from the "more options" menu:
#### Pin
Allows you to pin the Mind Map preview pane to the current note so that you can select other notes with the current Mind Map remaining in place. A pin icon will appear in the header of the Mind Map preview pane. Click the pin icon to unpin.
#### Copy screenshot
Places a copy of the Mind Map SVG on your clipboard allowing you to paste it into a note in Obsidian or into an image editor of your choice.
## Compatibility
Custom plugins are only available for Obsidian v0.9.7+.
The current API of this repo targets Obsidian **v0.9.20**.
## Installing
As of version [0.9.7 of Obsidian](https://forum.obsidian.md/t/obsidian-release-v0-9-7-insider-build/7628), this plugin is available to be installed directly from within the app. The plugin can be found in the Community Plugins directory which can be accessed from the Settings pane under Third Party Plugins.
## Manual installation
1. Download the [latest release](https://github.com/lynchjames/obsidian-mind-map/releases/latest)
1. Extract the obsidian-day-planner folder from the zip to your vault's plugins folder: `/.obsidian/plugins/`
Note: On some machines the `.obsidian` folder may be hidden. On MacOS you should be able to press `Command+Shift+Dot` to show the folder in Finder.
1. Reload Obsidian
1. If prompted about Safe Mode, you can disable safe mode and enable the plugin.
## For developers
Pull requests are both welcome and appreciated. 😀
If you would like to contribute to the development of this plugin, please follow the guidelines provided in [CONTRIBUTING.md](CONTRIBUTING.md).
## Donating
This plugin is provided free of charge. If you would like to donate something to me, you can via [PayPal](https://paypal.me/lynchjames2020). Thank you!