# obsidian-MarkMind **Repository Path**: TuLudong/obsidian-MarkMind ## Basic Information - **Project Name**: obsidian-MarkMind - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-12-09 - **Last Updated**: 2023-12-09 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Obsidian MarkMind [中文手册](https://github.com/MarkMindCkm/obsidian-MarkMind/blob/main/docs/%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8C.md) ### **Notice** This is not an open source project but [lishid](https://github.com/lishid) (obsidian developer) can check this code ### Feature Comparison | Free | Catalyst | | ---------------------------------------- | -------------------------------------------------- | | `Basic` mode of MindMap | Advanced features in `Rich` mode of MindMap | | Most features in `Rich` mode of MindMap | PDF annotate | | List mode | Support development | | PC and Mobile support | PC and Mobile support | | Not support | Export mindmap as pdf file | | $0 | $12 (forever) Buy [here](https://www.MarkMind.net) | You can try it for 30 days for free. After 30 days, you can purchase a code on the website ## MarkMind docs navigation ### MarkMind - [Create basic mode of MindMap](https://markmindckm.github.io/markmind-docs/index.html#/basic) - [Display basic mode to outline](https://markmindckm.github.io/markmind-docs/index.html#/outline) - [Display basic mode to table](https://markmindckm.github.io/markmind-docs/index.html#/table) - [Create rich mode of MindMap](https://markmindckm.github.io/markmind-docs/index.html#/rich) - [Get markdown text from rich mode of MindMap](https://markmindckm.github.io/markmind-docs/index.html#/markdown) - [Copy and paste node of MindMap](https://markmindckm.github.io/markmind-docs/index.html#/copy) - [Embed MindMap in other markdown file](https://markmindckm.github.io/markmind-docs/index.html#/embed) - [Common operations of MindMap](https://markmindckm.github.io/markmind-docs/index.html#/common) - Drag image from desktop to rich mode of MindMap - Copy text from browser to MindMap - Drag multiple nodes ### PDF annotator - [Setup and features](https://markmindckm.github.io/markmind-docs/index.html#/pdfAnnotator) - [Extracting annotations from PDF files](https://markmindckm.github.io/markmind-docs/index.html#/highlight) - [Committing highlights and notes to PDF](https://markmindckm.github.io/markmind-docs/index.html#/commitHighlight) - [Relate MindMap node with annotation](https://markmindckm.github.io/markmind-docs/index.html#/relate) ## Introduction Obsidian MarkMind is a mind map, outline, and PDF annotate tool based on Obsidian API ### Features: - Links - **Inline** ~~text~~ *styles* -
Multiline
text
### Other functions
- Exporting MindMap to image
- Use `CTRL + P` and click `Export to HTML` command
- Getting markdown in `rich` mode
- You can find `Copy as markdown` menu in `More options`
- Exporting MindMap to pdf
- download lasted obsidian,open a mind map in a independ window
- Use `CTRL + P` and click `Export mindmap as a pdf file` command
## PDF annotate
- Highlight text
- Area annotate
- Relate MindMap node and annotate
### How to use PDF annotate
1. Download the appropriate [PDFJS plugins](https://github.com/MarkMindCkm/obsidian-markmind/releases/download/1.8.2/pdfjs.zip)
2. Install PDFJS plugin:
- On Android, create an `andriod` folder then extract `pdfjs` folder into it
- On IOS, create an `ios` folder, then extract `pdfjs` folder into it
- The PDFJS path is set separately and if it does not you can try `filza` app, it can find the path to Obsidian
- On PC, extract `pdfjs` folder to `.obsidian` folder
- `CTRL/CMD + P`, click `set up pdfjs plugin path`
- On Mac `Command + Shift+ .` to show the hidden folder, extract `pdfjs` folder to `.obsidian` folder
- Restart Obsidian
3. Ensure these folders are present in PDFJS folder (VaultLocation\.obsidian\pdfjs):
- build
- epub
- epub.js
- pdfextrct
- web
4. Add the following YAML code to the MindMap document:
```YAML
---
annotate-target: test/test.PDF
annotate-type: pdf
---
```
5. Then you can find `Annotate PDF` in `more options`
### Screenshot folder for rect annotations
1. In the MindMap plugin settings you can set a folder path
- This should be a relative path pointing to your vault folder
2. Or you can add the folder path in YAML:
```YAML
---
annotate-target: test/test.PDF
annotate-type: pdf
annotate-image-target: assets/image
---
```
### Short Cuts for annotate
| Feature | Short Cut |
| ------------------ | ------------------------------- |
| Highlight Yellow | CTRL/CMD/ALT + Y |
| Highlight Green | CTRL/CMD/ALT + G |
| Highlight Blue | CTRL/CMD/ALT + B |
| Highlight Pink | CTRL/CMD/ALT + P |
| Highlight Red | CTRL/CMD/ALT + R |
| Delete annotate | CTRL/CMD/ALT + Delete/Backspace |
### Mind Map and PDF annotate
1. Open file as MindMap
2. Use `[[]]` to reference PDF
3. Click PDF reference, it will open a PDF reader if the PDF plugin path is correct
4. Use the PDF annotate function:
- It will create an `annos` file in your current folder by default, the `annos`
- The `annos` file stores annotations data in JSON format
- If you set the `Save PDF annotation type` as `markdown` in setting tab, it will create a `${PDF name}-annotate.md` file in your current folder
- Each annotation has an associated quote block with a block reference
- **Please do not modify these blocks**
### Relating MindMap nodes and annotations
There are three ways to relate mind map node and annotations
1. Default (Only supports rich mode)
- Make a PDF annotation
- Click PDF annotate
- Edit MindMap node and hit `CTRL/CMD + V` to relate the node and annotations
- Click the node PDF annotation and it will will auto copy the `id` of the annotation to your clipboard
2. Jumpto protocol `obsidian://jump-to-PDF` (Supports basic and rich mode)
- In MindMark settings, set `Support protocol` to `Open`
- This will automatically create a PDF annotation reference link and copy to your clipboard when you click PDF-annotate
- Paste into markdown file
3. Use markdown to save PDF annotations (Supports basic and rich mode)
- You can use `[[${md name}#${block reference}]]` to associate a 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
### Importing PDF highlight annotations
1. You can use `CTRL + P` and then the change basic to rich mode command
2. Import highlight annotations from PDF
- You can find this in the `more options` menu when opening a PDF
3. You can also export PDF annotations in the PDF format
- In the `more options` menu for the MindMap document
- You can set the format you want in the MarkMind settings tab
- The default format is:
```
Page:{{page}}
Text:{{highlightText}}
Comment:{{comment}}
^{{id}}
```
#### Demonstration
## Donating