summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas F. K. Jorna <[email protected]>2022-09-27 16:32:13 +0200
committerGitHub <[email protected]>2022-09-27 16:32:13 +0200
commit6f783297f37e95d083b32a7160afcb55e309e883 (patch)
treeaf9fdc3db50ecbc61036d88c81eeea3703ff17cc /README.md
parent16a8da9e5107833032893bc4c0680b368ac423ac (diff)
parent1936250b99b8747d841edd83002ed20ec12aa793 (diff)
feat: add ability to add/remove nodes to/from the local graph from emacs
Adds the commands `org-roam-ui-add-to-local-graph` and `org-roam-ui-remove-from-local-graph`
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.md b/README.md
index d64bac7..1bdd9a2 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@
- [Supporting org-roam-ui](#supporting-org-roam-ui)
- [Feedback](#feedback)
- [Contribute 💪](#contribute-)
- - [Hacktoberfest](#hacktoberfest)
+ - [Hacktoberfest](#hacktoberfest)
- [Donate](#donate)
- [Sponsors](#sponsors)
@@ -110,13 +110,13 @@ NOTE: This is quite janky at the moment and will change in the future. Consider
#### Moving around
```emacs-lisp
-(orui-node-zoom)
+(org-roam-ui-node-zoom)
```
Zooms to the current node in the global view _ignoring local mode_.
```emacs-lisp
-(orui-node-local)
+(org-roam-ui-node-local)
```
Opens the current node in local view.
@@ -129,6 +129,21 @@ You can optionally give these command three parameters:
These options might not work at the moment, please configure them in the UI for the time being.
+#### Manipulating graph
+
+```emacs-lisp
+(org-roam-ui-add-to-local-graph &optional id)
+```
+
+Adds the node with the given id to the local graph. If no id is given, the current node is used.
+If the local graph is not open, it will be opened.
+
+```emacs-lisp
+(org-roam-ui-remove-from-local-graph &optional id)
+```
+
+Removes the node with the given id from the local graph. If no id is given, the current node is used.
+
### Configuration
Org-Roam-UI exposes a few variables, but most of the customization is done in the web app.
@@ -369,7 +384,6 @@ If you are interested in being more closely involved with the project, go [here]
We would ❤️ to have you on board!
-
## Donate
If you really really like org-roam-ui, you can make a [one-time donation or sponsor one of us monthly!](https://github.com/sponsors/ThomasFKJorna/)