Merge branch 'develop'

robert-lag · Jul 9, 2022 · 28c689f · 28c689f
2 parents 3e0a77b + 9dfcb5e
commit 28c689f
Show file tree

Hide file tree

Showing 191 changed files with 133,604 additions and 27 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,4 +20,8 @@ indoc = "~1.0"
 tui = { version = "~0.16.0", features = ['crossterm'] }
 termion = "~1.5.6"
 crossterm = "~0.22.1"
-clipboard = "~0.5.0"
+clipboard = "~0.5.0"
+serde = { version = "~1.0.137", features = ["derive"] }
+serde_json = "~1.0.82"
+string-builder = "~0.2.0"
+include_dir = "0.6"
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ More information about the zettelkasten method:
     - [Creating a new zettelkasten](#creating-a-new-zettelkasten)
     - [Adding notes](#adding-notes)
     - [Listing created notes](#listing-created-notes)
+    - [Graph View](#graph-view)
     - [TUI Mode](#tui-mode)
         - [Keybindings in TUI Mode](#keybindings-in-tui-mode)
 - [Note types](#note-types)
@@ -50,6 +51,7 @@ Some of the most important features:
 - Notes are stored as simple **Markdown** files
 - Your **Favorite editor** can be used for editing notes
 - **Minimal** (non-bloated) software
+- A **Graph View** you can view in your browser
 
 ## Installation
 
@@ -124,6 +126,26 @@ You can open a note either in the TUI mode or on the commandline:
 brn open <note-id>
 ~~~
 
+### Graph View
+
+To view a graphical representation of the zettelkasten type:
+
+~~~
+brn graph
+~~~
+
+This will open a graph in the browser specified by the `BROWSER` environment variable.
+
+![graph-view](https://user-images.githubusercontent.com/61148783/178108696-311f347d-08c9-4ada-acb8-b312b1f28ab0.png)
+
+By clicking on a graph node you can see the name of the note the graph node represents.
+
+![graph-view-node-selection](https://user-images.githubusercontent.com/61148783/178109252-b787c6f4-4c7d-49a9-9d87-9d3d67986f13.png)
+
+It's also possible to select multiple nodes by pressing `Shift` and selecting nodes. This can be done either by pressing the nodes one by one or by using box selection (while pressing `Shift`).
+
+![graph-view-multiple-selections](https://user-images.githubusercontent.com/61148783/178109250-ac7669de-4278-4260-98bb-783440857357.png)
+
 ### TUI mode
 
 The TUI mode makes it easier to traverse thourgh your zettelkasten.
@@ -404,4 +426,4 @@ This will result in:
 T20210718000005 my-first-note
 ~~~
 
-Note that the journal now doesn't appear as the note is not a Topic-note but a Journal-note.
+Note that the journal now doesn't appear as the note is not a Topic-note but a Journal-note.