/obsidian-mind-map

An Obsidian plugin for displaying markdown notes as mind maps using Markmap.

Primary LanguageTypeScriptMIT LicenseMIT

Obsidian Mind Map

GitHub Workflow Status GitHub release (latest SemVer)

This repository contains a plugin for Obsidian for viewing Markdown notes as Mind Maps using Markmap.

A similar plugin is available for Visual Studio Code.

Features

  • Preview your current note as a Mind Map
  • Mind Map preview updates as you select other panes, similar to the Local Graph, Outline and Backlink panes

Mind Map Demo Image

Usage

You can open the Mind Map preview for the current note with a command.

Mind Map Preview Command

Preview More Options Menu

The Mind Map Preview view has 2 options from the "more options" menu:

Mind Map Preview More Options

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, 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
  2. Extract the obsidian-day-planner folder from the zip to your vault's plugins folder: <vault>/.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.
  3. Reload Obsidian
  4. 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.

Donating

This plugin is provided free of charge. If you would like to donate something to me, you can via PayPal. Thank you!