From 3f28da87e32790a0f5f92ce7071bceb92f4a1aa5 Mon Sep 17 00:00:00 2001 From: "Thomas F. K. Jorna" Date: Tue, 27 Sep 2022 16:16:11 +0200 Subject: docs: add docs about add-node-to-local-graph --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) (limited to 'README.md') 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/) -- cgit v1.2.3