https://github.com/shaunhurryup/lovely-mindmap
Build your own knowledge graph with smiles :-)
https://github.com/shaunhurryup/lovely-mindmap
Last synced: 4 months ago
JSON representation
Build your own knowledge graph with smiles :-)
- Host: GitHub
- URL: https://github.com/shaunhurryup/lovely-mindmap
- Owner: shaunhurryup
- License: mit
- Created: 2023-06-25T01:50:48.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-05T13:37:41.000Z (9 months ago)
- Last Synced: 2024-08-13T07:16:32.934Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.9 MB
- Stars: 50
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - shaunhurryup/lovely-mindmap - Build your own knowledge graph with smiles :-) (TypeScript)
README
# Lovely-Mindmap
Obsidian canvas plugin to build your own knowledge graph with smiles : )
It is named mindmap, but not only mindmap.
We will continue to introduce new features!
**Your unique and innovative idea has a good chance of being adopted by us.**
Feel free to leave feature suggestions but please don't open issues for bugs or support requests just yet.
Any suggestion or question 👉 [Discord](https://discord.gg/gSdhPNeG)
# 📕 Feature
As a plugin of mindmap, you can find basic mindmap feature in this plugin.
- `Tab` create child node and zoom to fit
- `Enter` create sibling node and zoom to fit
- `Shift + Enter` create sibling before and zoom to fit
- `cmd + Esc` blur selection node and start navigating. [Why not `Esc`](https://github.com/xincan1949/lovely-mindmap#-qa:~:text=exit%20creating%20view%3F-,For%20two%20reasons%3A,-Individual%20Esc%20keyboard) ?
- `opt + ↑↓←→` move around nodes with smart intention
# 🐮 Advanced
## 🕹 View
We declare three views in Lovely-Mindmap, they look similar, but have different interactions.
> Touch: No nodes are selected
> Navigation: One _or more_ nodes are selected, you can do something
In the current scene, we just find the need to create and change the selection of a node.
We believe that in the feature, there will be various needs for multiple node interactions, such as layout.
> Creation: One node is selected, and you can find the cursor inside the node
When you are creating, we don't want your thoughts and inspiration to be interrupted.
So at the plugin level, we only provide `cmd + Esc` to exit.
That means the modifier will do its original job,
`Enter` can wrap lines,
`cmd + ←→` can move the cursor to the beginning/end of the line.
## Dive into
As an accessibility enthusiast, I don't want to take my hands off the keyboard.
The keyboard `f` may be the first step to start your creation.
In touch view, `f` select the node closest to the center of the viewport.
In Navigation view, `f` activate selection node and start editing.
## 🚧 TODO
- [ ] Canvas should only be applied in active graph
- [ ] Double `f` create node in the middle if no node in viewport
Not sure
- [ ] Automatically expand node while creating
Not sure
- [ ] Find node by keyword and zoom to fit
Woah!
- [ ] Import file like lark, XMind, and so on
Woah!
- [ ] Export obsidian mindmap to specified file format
Woah!
- [ ] Organize graph in a neat manner
Woah! I have both flexibility and practicality!
- [ ] Collision detection to avoid overlap
Woah!
- [ ] Create different layout by shortcut or option
Woah!
- [ ] `opt + ↑↓←→` will move to next node out of the viewport if you confirm
Woah!
- [ ] 🥰 User suggestion
As mentioned at the beginning, **Your unique and innovative idea has a good chance of being adopted by us.**
# ✨ Change Log
- 09/21/2024 Fix shortcut key conflicts and allow customizable hotkeys
- 06/20/2024 Remove keymaps when viewport switched to non-canvas
- 07/06/2023 Debounce is support when nodes are created by `Enter` or `Tab`
- 07/05/2023 Fix the first time you enter the editor canvas instance may be undefined
- 07/04/2023 Fix keyboard F fail to focus the nearest central node in viewport
- 07/04/2023 Fix node generated by Tab shortcut position error
# 🤔 Q&A
> Why do I need press `cmd + Esc` instead of `Esc` to exit creating view?
For two reasons:
1. Individual `Esc` keyboard events cannot be listened
2. Focus mode should be hard to interrupt
If needed, we'll consider putting it in the setting as a switch.
# ☕️ Donate
If you are interested in the project, you can ⭐STAR️⭐️ it~
If you think the project is lovely and enjoy creation, you can donate it~
> [By Me a Coffee](https://www.buymeacoffee.com/xincan1949)
> 当您通过以下方式进行捐赠时，请务必留下备注【Lovely-Mindmap】和姓名、GitHub 账号、其他社交媒体账号之一，以便我将其添加到捐赠者名单中，以表谢意。
支付宝
微信
Thanks for the sponsorship below
1. *云（微信）
2. Shiki（微信）
3. *春（微信）