MarkMindCkm / obsidian-markmind Public

Obsidian mark mind

Notice

This is not an open source project .
Web site : https://www.markmind.net

Price

free	Catalyst
`basic` mode of mindmap	advanced features in `rich` mode of mind map
most features in `rich` mode of mindmap	pdf annotate
list mode	support development
support mobile and pc	support mobile and pc
$0	$12 （forever）
	Buy

You can try it for 30 days for free，and you can buy a active code in website , then input it in setting tab

Introduction

Obsidian mark mind is a mind map,outline and pdf annotate tool base on obsidian api.

Mind map introduction

it contains two modes : basic and rich

Add yaml to markdown:

---

mindmap-plugin: basic (or rich)

---

Then you can find Open as mindmap menu in more options

In `basic` mode

You can use the basic mind map function and use outline mode , it like the obsidian-enhancing-mindmap plugin.

`basic` mode will output this markdown:

---

mindmap-plugin: basic

---

# Mark mind for obsidian

## Links
- <https://github.com/MarkMindLtd/obsidian-markmind>
- [GitHub](https://github.com/MarkMindLtd/obsidian-markmind)

## Related
- [coc-markmap](https://github.com/gera2ld/coc-markmap)
- [gatsby-remark-markmap](https://github.com/gera2ld/gatsby-remark-markmap)

## Features
- links
- **inline** ~~text~~ *styles*
- multiline
   text
- `inline code`
- Katex - $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$

Outline

You can add yaml to active outline mode:

---

mindmap-plugin: basic
display-mode: outline

---

Outline short cut

Features	Short Cut
New Brother Node	Enter
Indent	Tab
Unindent	Shift+Tab
Zoom in	Ctrl/Cmd+] Or Double Click Dott
Zoom out	Ctrl/Cmd+[
Move Up Or Down Node	Ctrl/Cmd + up/down

table

You can add yaml to active table mode:

---

mindmap-plugin: basic
display-mode: table

---

In `rich` mode

You can use all functions of mind map .

add summary
add boundary
add node relate link
add free node

Rich mode will output this markdown:

---

mindmap-plugin: rich

---

# md 

``` json
{...}
```

The mindmap data will store to json.

mindmap short cut

New Mind Map	Ctrl/Cmd+P
New child node	Tab
New brother node	enter
Delete node	Delete/Backspace
edit node	Space/dblclick node
Undo	Ctrl/Cmd+Z
Redo	Ctrl/Cmd+Y
Quit edit node	Tab
Expand node	Ctrl/Cmd + /
Collapse node	Ctrl/Cmd + /
Move node to another node	Drag and drop node
Tab node	Up/down/left/right
Zoom in/out	Ctrl/Cmd + mouse wheel
Mind map to center	Ctrl/Cmd + E
Change mindmap layout	select node,Ctrl/Cmd + U / D / L / R / M / J / K / T / Q
delete summary / boundary / relate link	Delete/Backspace

How to get markdown in `rich` mode ?

You can find Copy as markdown menu in more options.

How to export mindmap to image?

Use ctrl + p , execute export to html command

PDF annotate

highlight text
area annotate
relate mind map node and annotate

How to use pdf annotate

You need download pdf js plugin ,Open setting tab to set up pdf plugin path , for example:D:plugins/pdfjs , It is a absolute path

PC pdfjs plugin
andrios pdfjs plugin
ios pdfjs plugin

About iPhone/iPad pdfjs path: for example (iPad), you create ios folder in your vault , then put pdfjs plugin into it , the path will like this /var/mobile/Containers/Data/Application/FACF6387-DAA2-45B3-8F52-3536E1EC29A1/Documents/ios/pdfjs

FACF6387-DAA2-45B3-8F52-3536E1EC29A1 are different on each device

About andriod pdfjs path,for example,like this /storage/emulated/0/Documents/obsidian/obsidian/andriod/pdfjs

About PC pdfjs path,like this

D:plugin/pdfjs

How to set up your pdfjs plugin path?

In pc , you can open setting tab and input absolute path to pdfjs plugin
In mobile , you can open command board , then you can find a set up mobile pdf js plugin path command ,then click it

download lastest pdfjs plugin ，unzip it
in andriod , create a andriod folder then put pdfjs folder in it
in ios , create a ios folder then put pdfjs folder in it
open a mind map
call up command board , then you can find a set up mobile pdfjs plugin path command , click it
restart obsidian and check path in obsidian markmind setting tab

The pdf js path need set separately and if it is not work above in ios , you can try filza app , it can find obsidian path

Markdown

Add yaml to markdown file:

---

annotate-target: test/test.pdf
annotate-type: pdf

---

Then you can find menu annotate pdf in more options;

short cut of pdf annoate

Features	Short Cut
Highlight Yellow	ALT + Y
Highlight Green	ALT + G
Highlight Blue	ALT + B
Highlight Pink	ALT + P
Highlight Red	ALT + R
Delete annotate	ALT + Delete/Backspace

Mind Map and pdf annotate

Open as mind map
Use [[]] to reference pdf
Click pdf reference , it will open a pdf reader if pdf plugin path is correct
Use pdf annotate function
- it will create annos file in your folder as default, the annos file store annotations data,annos file is a json file in fact
- if you select (save pdf annotation type ) markdown in setting tab , it will create ${pdf name}-annotate.md file in your folder. Each annotation has an associated quote block with a block reference. please do not modify these blocks

How to relate mind map node and annotate?

There are three ways to relate mind map node and annotate

Default (only support rich mode)

make a pdf annotate
click pdf annotate
edit mind map node , ctrl/cmd + v to relate node and annotate
click node pdf annotate mark will auto copy id of annotate to clipboard

Support `obsidian://jump-to-pdf` protocol (support basic and rich mode)

open protocol support in setting tab
automatic create PDF annotation reference link and copy to clipboard when click pdf-annotate
paste to markdown file

If you use markdown to save pdf annotations (support basic and rich mode)

you can use [[${md name}#${block reference}]] to associate quote block with a block reference.
An obsidian link to an annotation block-reference will, when clicked, open the corresponding file and scroll to the associated highlight. If the file is already open in a pane, then the link will cause the existing pane to scroll instead.

Demonstration

Donating

Change log v1.4.0

notice : v1.3.9 has update pdfjs plugin . See detail

fix #231 ， you can add link variable in setting tab when export pdf annotations

Page:{{page}}
<span style="color:{{color}}">■</span>:{{highlightText}} 
Comment:{{comment}}
[📌]({{link}})
^{{id}}

fix #174 , it can work directly with Obsidian Extended Table plugins https://github.com/aidenlx/table-extended ， when use table mode , you can find a menu get markdown of this table , click it ,then copy it to a md file , open table-extended plugin ,notice : not support wrap in table

---
mindmap-plugin: basic
display-mode: table
---

list mode support parse ![[mind map md]] to a real mind map
fix basic mode mind map parse ![[mind map md]] bug

table mode with table extended plugin

export pdf annotations

v1.3.9

notice : pc pdfjs plugin need update pc pdf js plugin

pdf js plugin

add a short cut ctrl + c to select text
fix cannot click copy btn bug when click a annotate
fix loss annotate-image-target bug when save pdf annotations

---
annotate-type: pdf
annotate-target: pdf/test.pdf
annotate-image-target: test/test
---

mind map

add scale button in mind map
fix #226 , you can add color variable in setting tab when export pdf annotations

Page:{{page}}
<span style="color:{{color}}">■</span>:{{highlightText}} 
Comment:{{comment}}
^{{id}}

support search mindmap node ， add a menu toggle search box in more options
fix #203 , support only copy pdf annotate text
support micro adjustment of the height of the pdf annotate. you can add an upward or downward adjustment distance in the setting tab
add a short cut alt + i to toggle create rect annotate status
fix #131 , support set up folder path for image of rect annotate in yaml , this is a relative path to a folder in your vault , please update pc pdfjs plugin

---
annotate-type: pdf
annotate-target: pdf/test.pdf
annotate-image-target: test/test
---

copy text

add folder path for image of rect annotate

adjust height of annotate

search node

v1.3.7

add command to toggle version of pc pdfjs plugin in command board （ctrl + p）
please update PC pdfjs plugin pc pdfjs plugin

support old and new version （ #197 ）
support highlight text by use shortcut key ( alt + y/r/g/p/b )
fix #197
- In rare cases, due to the problem of PDF format, there will be problems in the text selection of the new version. You can use the old version to solve them
- Generally, please use the new version ,better experience with the new version

v1.3.6 has update mobile pdfjs plugin https://github.com/MarkMindCkm/obsidian-markmind/releases/tag/1.3.6

v1.3.6

fix #196
fix #184
mobile pdfjs plugin is release , please download mobile pdfjs

notice: long touch to select text

mobile.pdfjs.mp4

1.3.5

fix #159
support create rich mode from basic mode , you can use ctrl + p , then you can find change basic to rich mode command
import highlight annotations from pdf this function is release , you can find a menu in 'more options' when open a pdf
support export pdf annotations as a format , you can find a menu in more options , you can setup format in setting tab , the default format is

Page:{{page}}
Text:{{highlightText}} 
Comment:{{comment}}
^{{id}}

1.3.4

reconstruct PDF annotation , this is only for pc version pdfjs plugin
optimize some mind mapping functions

v1.3.3

notice : v1.3.2 pc pdf js plugin has update , pdfjs

support change relate link of node , now support line/polyline/bessel curve
add a theme , support for white board

     
---

mindmap-plugin: rich
mindmap-theme: whiteboard

---

1.3.2 update

fix parse ![[mindmap md]] in table mode
fix parse ![[ table mode mindmap md]] to real table in node of mindmap/markdown file
fix export table mode mindmap to html
fix #157
support create free node , the text is ![[ file name]] when drag file of vault to rich mode,the extension support md/png/gif/jpg
get markdown table added in options when in table mode

Internal test function , allow only purchased users to use

please update pc pdfjs download internal pdfjs and manual download obsidian markmind download internal ob markmind
pc pdfjs support import existing PDF highlights (in more options) , #99

Internal test function

1.3.1

Making table in markdown is very troublesome, so table mode is added to basic mode for make table visually

you can add display-mode: table in basic mode yaml
or you can find open as table in more options
support get table html code , you can find get table html in more options when in table mode
support enter/tab short cut , support edit text by dblclick
not support drag and drop , you can change node position in mindmap mode

---
mindmap-plugin: basic
display-mode: table
---

1.3.0

fix #152 fix #150 fix #149

v1.2.9

add a layout vertical time , the short cut is ctrl + k
add a layout fish right , the short cut is ctrl + q
add a layout fish left, the short cut is ctrl + t

Previous projects have been basically completed , this is plan for this year https://github.com/MarkMindCkm/obsidian-markmind/projects

v1.2.8

fix parse ![[mindmap md name]] bug when node has image fix style of node

v1.2.7

fix #138
fix #130
fix #129 , support parse ![[mindmap md name]] to mindmap in mindmap node
fix #124 , support parse ![[mindmap md name]] to mindmap in md file

v1.2.6

add more options of canvas size in setting tab
optimize the logic of the pop-up node setting box
support export mindmap to html , use ctrl + p , then you can find export to html command , notice :
- not support blank link
- not suport ![[svg/pdf/mp4]] , only support ![[png/jpg]] in node , image in mindmap must be local
- support export mathematical formul
- not support mobile
- If the mind map is too large, it cannot be exported , max export size is 16384 * 16384 (px)

1.2.5

Optimize the interaction of node setting box
ctrl/cmd + mouse click to select nodes , not support right click
add set up mac pdf js plugin path
notice : enhancing mindmap support export mindmap to image , it will be transplanted soon

1.2.4

Right click to select nodes and left click to move the mind map
In rich mode , support set up node background/stroke/text color/text size，if you want to change colors of node setup board , you can input setup board color in setting tab please restart obsidian

1.2.3

fix v1.2.2 tab/enter bug

v1.2.2

fix #108
fix #103
add copy and paste command (ctrl + p ) , support copy and paste node on mind maps
Optimize input, select the node, press spacebar to edit the node in append mode, and press other keys to edit in overwrite mode

v1.2.1

Nitice:
Please update pdfjs plugin to v1.2.0 , the pc support epub file , the detail is there v1.2.0

fix set up pdf js plugin bug

***How to set up pdf js plugin ***

download lastest pdfjs plugin ，unzip it
in andriod , create a andriod folder then put pdfjs folder in it
in ios , create a ios folder then put pdfjs folder in it
open a mind map
call up command board , then you can find a set up mobile pdfjs plugin path command , click it
restart obsidian and check path in obsidian markmind setting tab

The pdf js path need set separately and if it is not work above in ios , you can try filza app , it can find obsidian path

v1.2.0

Important
Please update pdfjs plugin , pc version support epub file , mobile will support near future
PC pdfjs plugin
andrios pdfjs plugin
ios pdfjs plugin

fix #87
support read and annotate epub file,this is beta function

add yaml to md

---

annotate-target: test.epub
annotate-type: epub

---

then you can find annotate epub in more options

fix miss $ when save data bug
simplify set up mobile pdfjs plugin path
- download lastest pdfjs plugin ，unzip it
- in andriod , create a andriod folder then put pdfjs folder in it
- in ios , create a ios folder then put pdfjs folder in it
- open a mind map
- call up command board , then you can find a set up mobile pdfjs plugin path command , click it

epub

set up mobile pdf js plugin path

86a9d249aaa93c6b5b215462ea5f7550.mp4

v1.1.9

Important : ios pdfjs plugin update !

fix cannot use highlight text in ios system download ios pdfjs plugin
support parse code block in markdown file , you should open it in setting tab and restart obsidian

``` mindmap

# Mark mind for obsidian

## Links
- 
- [GitHub](https://github.com/MarkMindLtd/obsidian-markmind)

## Related
- [coc-markmap](https://github.com/gera2ld/coc-markmap)
- [gatsby-remark-markmap](https://github.com/gera2ld/gatsby-remark-markmap)

## Features
- links
- **inline** ~~text~~ *styles*
- multiline
   text
- `inline code`
- Katex - $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
  
```

ipad annotate

94.1.mp4

v1.1.8

important: please update pc pdf js to v1.1.7

pc pdf js plugin

support a new layout in rich mode of mind map , the short cut is Ctrl/Cmd + J
support import xmind zen file in rich mode of mind map , the way is drag xmind zen file and drop to blank space of mind map in rich mode
fix some times can not add/remove free node bug

This is a xmind zen demo

Import xmind zen file

Ctrl + J change to new layout

v1.1.7

important: please update pc pdf js

pc pdf js plugin

fix basic mode can add free node bug
fix export annotate pdf in pc version

v1.1.6

important

please update pc pdfjs plugin ， mobile pdfjs plugin will update next version

PC pdfjs plugin

fix #60 , add pdf annotate short cut
fix #61
fix #64
fix #66
mindmap node support smooth move , you shoud open it in setting tab
In rich mode of mindmap , double click the blank space can add free node
fix #57

pdf annotate Features	Short Cut
Highlight Yellow	ALT + Y
Highlight Green	ALT + G
Highlight Blue	ALT + B
Highlight Pink	ALT + P
Highlight Red	ALT + R
Delete annotate	ALT + Delete/Backspace

v1.1.5

important:
Please update pdfjs plugin to v1.1.1 version

PC : PC pdfjs plugin
Andriod Andriod pdf js plugin
iPhone/iPad : iPhone/iPad pdf js plugin

support add note to mind map node in rich mode , note support markdown
summary node support add child node
(ctrl + p) add a command get base path of vault , it will auto copy to clipboard

v1.1.4

fix delete summary bug when edit node use backspace/delete key

v1.1.3

fix #54
fix #28
fix miss code and link bug in outline mode

v1.1.2

fix #46
add set mindmap to center menu in more options

v1.1.1

important:
Mobile pdf js plugin need to download again

PC: PC pdfjs plugin
Andriod Andriod pdf js plugin
iPhone/iPad : iPhone/iPad pdf js plugin

fix iPhone/iPad cannot use pdf annotate bug

Please set up pdfjs path in setting tab , this is a absolute path ,( you can find absolute path of your vault in obsidian app ) the best way is create a folder in your vault , for example :plugin folder, then put pdfjs plugin in it

About iPhone/iPad pdfjs path: for example (iPad), you create plugin folder in your vault , then put pdfjs plugin into it , the path will like this
/var/mobile/Containers/Data/Application/FACF6387-DAA2-45B3-8F52-3536E1EC29A1/Documents/plugin/pdfjs

FACF6387-DAA2-45B3-8F52-3536E1EC29A1 are different on each device

About andriod pdfjs path,like this
/storage/emulated/0/Documents/obsidian/obsidian/plugin/pdfjs

About PC pdfjs path,like this

D:plugin/pdfjs

iPad screen short

v1.1.0

Important In this version ,You should download pdfjs plugin again

PC : Pdf js plugin
Andriod Andriod pdf js plugin
iPhone/iPad : iPhone/iPad pdf js plugin

You should set up pdf js plugin path in setting tab , it is a absolute path
For example :

D:plugins/pdfjs in pc
/storage/emulated/0/Documents/obsidian/obsidian/plugin/pdfjs in andriod

you should put pdfjs plugin to a accessible folder in mobile . you can find your vault path in mobile app , the best way is create a folder(for example plugin folder) in your vault , then put pdfjs plugin in it.

fix #40 ， you can select mode of mindmap (when create mindmap) in setting tab , the default is basic
pdf annotate support mobile , only support pdf of your vault , not support file://
in md file , support use [[md#^node id]] to reference node of rich mode mindmap , you can find menu copy node id in more options
support set up image folder in setting tab to save image of pdf rect annotate .
- for example : Screenshot , the Screenshot folder must be exists in your vault, the image of rect annotate will be save to Screenshot folder
fix when annotate file:// pdf path cannot use rect annotate bug
support 3 theme of mindmap , you can add yaml to markdown

---

mindmap-plugin: basic( or rich )
mindmap-theme: dark(or light or card)  

---

Markmind all functions will support mobile and pc from this version ,andriod/apple/window/linux has consistent experience.

v1.0.9

this is a big version

fix #4 , pdf annotate support all pdf files on disks by using file:// ，this feature can only use to desktop app , if you use file:// , the annotatios will be save to this markdown file

annotate-target: file://pdf absolute path
annotate-type: pdf

fix #29 , support mobile from this version， it has consistent experience with desktop version
add command :

select node , change layout in rich mode of mindmap
toggle markdown and mindmap mode
add some menus of more options in rich mode of mindmap ，(copy text to clipboard automatic)
- Copy node text as markdown (contains children)，the text type like basic mode
- Copy node text (only this node)
- Copy node links , you can reference it in other md file

support change summary/boundary/relate link color
if you set up active code in setting tab of desktop version , it will create mobile active code in your plugin obsidian-markmind data.json automatic
support move root of mindmap in rich mode

v1.0.8

fix #26
fix miss markdown format in list mode when use ctrl + down / up

v1.0.7

fix #24 , fix pdf select multi line to highlight , this problem is caused by pdf plugin

Important: You should to download the pdfjs plugin again PDFJS Plugin, it keep more functions and it support multi open
PC : Pdf js plugin
Andriod Andriod pdf js plugin
iPhone/iPad : iPhone/iPad pdf js plugin

v1.0.6

emergency fix #22
emergency fix #21

v1.0.5

emergency fix mindmap rich mode bug

v1.0.4

This is a big version: Notice: You should to download the pdfjs plugin PDFJS Plugin, it keep more functions and it support multi open

1, fix #18 , you can select pdf viewer theme in setting tab
2. fix #17
3. fix #15
4. fix #8
5. Support multi open pdf annotate
6. support add comment to annotation
7. support committing highlights and notes to PDFs ，you can find export pdf annotate menu in more menus , it will create a file in your folder,the name is ${pdf name}-annotate.pdf
8. Split PDF annotation and mindmap function
9. change in basic mode , mind map layout from tree to mind map
10. fix #2 , in rich mode

if save data first time , it will output this markdown
if it is not the first time to save data , it will only replace '${mindmap data}', so you can change md file
if you want to reference node , it will automatic create mind map node reference link and copy to clipboard when click node and press ctrl or command

  
---
mindmap-plugin: rich
---

# title
``` json
  ${mindmap data}
```

The use type of PDF annotation has changed , if you want to use annotate function, you can add yaml to markdown file:

---

annotate-target: test/test.pdf
annotate-type: pdf

---

then you can find annotate pdf menu in more menus

you can select md or annos to save annotations in setting tab

annos is default , it is json file in fact , you can use obsidian://jump-to-pdf to reference annotate ,
- annotations do not contaminate MD files When referenced
md is the recommended way
- you can use obsidian://jump-to-pdf to reference annotate
- or you can ![[ md#^block id]] to to reference annotate

please open obsidian://jump-to-pdf protocol in setting tab