Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.05 KB

README_en_US.md

File metadata and controls

46 lines (29 loc) · 2.05 KB

中文

siyuanPligin-TreeAndGraph

Siyuan Notes Plug-ins, which display parent-child relationships and link relationships, etc. in a tree view, created using echarts.

How to use

By default, a new dock appears on the right, click it, pay attention to put the cursor in a block first, the block will be used as the starting node (every time you open a new dock, it will be initialize again according to the block where the cursor is located as the starting node).

Features and Plans

Basic Features

  • Roam(scale and move)(v1.0)
  • Collapse and expand nodes (left-click)(v1.0)
  • Displays the block content or type(v1.0)
  • Display block details(hover)(v1.1)
  • Displays the label tree(v2.0)
  • Highlight edge when mouse over (v2.2)
  • Display reference type (v2.3), currently achieved by recognizing memos on the reference anchor-text - [ ] Use different colors distinguish different block types

Right-click Menu

  • Extend nodes(Added nodes will be updated)(v1.0)
  • Locate nodes in notes (document tab)(v1.1)
  • View the node in a floating pannel(v1.1)
  • Focus Node(unfocus button is on the toolbar)(v2.1) - [ ] Delete the node

Feedback

If you have any questions, please put a issue at github issues.

Thanks

Development Notes

  • ❗❗❗ In order to unify project methods and types, Siyuan API-related methods and types are in the project siyuanPlugin-common .
  • ❗ For ease of development with TypeScript, the 'echarts/types/dist/shared' file has been modified , some types have been added prefix export.