foam-template/docs/features/graph-visualization.md
Riccardo d9028e82fb
Added onboarding and major changes to template (#28)
* removed gitlens

* adjusted various settings

* added foam onboarding to template

* removed prettier extension

* added setting to match OS color scheme

* a couple of minor changes re todos and readme

* added spellright to list of recommended extensions, and added to getting started guide

* added reference to LTeX in spell checking doc

* Added logo to readme

* fixed link to LTeX extension

* styling logo in readme

* more style experiments
2021-01-22 13:17:24 +00:00

43 lines
1.7 KiB
Markdown

# Graph Visualization
Foam comes with a graph visualization of your notes.
To see the graph execute the `Foam: Show Graph` command.
## Graph Navigation
With the graph you can:
- highlight a node by hovering on it, to quickly see how it's connected to the rest of your notes
- select one or more (by keeping `shift` pressed while selecting) nodes by clicking on them, to better understand the structure of your notes
- navigate to a note by clicking on it while pressing `ctrl` or `cmd`
- automatically center the graph on the currently edited note, to immediately see it's connections
## Custom Graph Styles
By default the Foam graph will use the VsCode theme, but it's possible to customize it with the `foam.graph.style` setting.
A sample configuration object is provided below, you can provide as many or as little configuration as you wish:
```json
"foam.graph.style": {
"background": "#202020",
"fontSize": 12,
"highlightedForeground": "#f9c74f",
"node": {
"note": "#277da1",
"placeholder": "#545454",
"feature": "green",
}
}
```
- `note` defines the color for regular nodes
- `placeholder` defines the color for links that don't match any existing note. This is a [[placeholder]] because no file with such name exists (see [[wiki-links]] for more info).
- `feature` shows an example of how you can use note types to customize the graph. It defines the color for the notes of type `feature`
- see [[note-properties]] for details
- you can have as many types as you want
[//begin]: # "Autogenerated link references for markdown compatibility"
[wiki-links]: wiki-links.md "Wiki Links"
[note-properties]: note-properties.md "Note Properties"
[//end]: # "Autogenerated link references"