(docs): add documentation for using neato (#291)

Some prefer using neato for generating a graph (ref #263). This
documents how to do so.
This commit is contained in:
Jethro Kuan
2020-03-13 13:37:55 +08:00
committed by GitHub
parent e64890c80e
commit a44b847596
2 changed files with 7 additions and 2 deletions

View File

@@ -101,6 +101,13 @@ Org-roam tries its best to locate the Graphviz executable from your
(setq org-roam-graphviz-executable "/path/to/dot") (setq org-roam-graphviz-executable "/path/to/dot")
``` ```
You may also choose to use `neato` in place of `dot`, which generates a more compact graph layout.
```
(setq org-roam-graphviz-executable "/path/to/neato")
(setq org-roam-graphviz-extra-options '(("overlap" . "false")))
```
Org-roam also attempts to use Firefox (located on `PATH`) to view the Org-roam also attempts to use Firefox (located on `PATH`) to view the
SVG, you may choose to set it to any compatible program: SVG, you may choose to set it to any compatible program:

View File

@@ -1278,8 +1278,6 @@ into a digraph."
If PREFIX, then the graph is generated but the viewer is not invoked." If PREFIX, then the graph is generated but the viewer is not invoked."
(interactive "P") (interactive "P")
(declare (indent 0)) (declare (indent 0))
(unless org-roam-graphviz-executable
(setq org-roam-graphviz-executable (executable-find "dot")))
(unless org-roam-graphviz-executable (unless org-roam-graphviz-executable
(user-error "Can't find graphviz executable. Please check if it is in your path")) (user-error "Can't find graphviz executable. Please check if it is in your path"))
(let ((temp-dot (expand-file-name "graph.dot" temporary-file-directory)) (let ((temp-dot (expand-file-name "graph.dot" temporary-file-directory))