mirror of
https://github.com/calfmoon/node-factor.git
synced 2026-07-22 05:42:24 +00:00
doc: update README
This commit is contained in:
parent
58c75de5c3
commit
daa3db93b7
4 changed files with 22 additions and 1 deletions
21
README.md
21
README.md
|
|
@ -1 +1,22 @@
|
|||
# Obsidian Node Factor
|
||||
This plugin helps you customize the factors that effect node size in obsidian graph view.
|
||||
The factors include, letter count, forward & backward weight, and forward tree weight.
|
||||
<img src="./screenshots/1.jpeg">
|
||||
<img src="./screenshots/2.jpeg">
|
||||
## Installation
|
||||
1. Search for "Node Factor" in Obsidian's community plugin browser.
|
||||
2. Install it.
|
||||
3. Enable the plugin in your Obsidian settings under "Community plugins".
|
||||
## Configuration Options
|
||||
| Option | Meaning | Default value |
|
||||
| ------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------- |
|
||||
| Forward link weight multiplier | Weight of single link coming out of a node | 1 |
|
||||
| Travel forward tree | Determines if forward weight is decided by just the immediate nodes coming out or everything after it | off |
|
||||
| Backward link weight multiplier | Weight of single link coming out of a node | 1 |
|
||||
| Character per weight | Given number of letters give 1 weight | 0 |
|
||||
## Author
|
||||
CalfMoon: [Email](kritagyabhattarai@proton.me), [Github](https://github.com/CalfMoon)
|
||||
## Bug Reports
|
||||
This project still new and might have a few bugs. For bug reports use this repo's Issues section.
|
||||
## License
|
||||
OBSD, see [LICENSE](LICENSE).
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
"name": "Node Factor",
|
||||
"version": "1.0.0",
|
||||
"minAppVersion": "0.15.0",
|
||||
"description": "Demonstrates some of the capabilities of the Obsidian API.",
|
||||
"description": "Customize factors effecting node size in graph.",
|
||||
"author": "CalfMoon",
|
||||
"authorUrl": "https://github.com/CalfMoon",
|
||||
"isDesktopOnly": false
|
||||
|
|
|
|||
BIN
screenshots/1.jpeg
Normal file
BIN
screenshots/1.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
BIN
screenshots/2.jpeg
Normal file
BIN
screenshots/2.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Loading…
Reference in a new issue