Update README.md

README.md

@@ -1,30 +1,59 @@
 # Memo
 
-Markdown knowledge base with bidirectional [[link]]s built on top of [VSCode](https:/microsoft/vscode). Inspired by [Obsidian.md](https://obsidian.md/) and [RoamResearch](https://roamresearch.com/).
+Markdown knowledge base with bidirectional [[link]]s built on top of [VSCode](https:/microsoft/vscode).
+
+Inspired by [Obsidian.md](https://obsidian.md/) and [RoamResearch](https://roamresearch.com/).
 
 ## Why?
 
-Because your personal knowledge base software deserves to be open source.
+Because your knowledge base deserves to be powered by open source.
 
 ## Features
 
-- Creating links 📙
+- 🔗 **Links support**
+
+ - Creating links
+
+ - ![Creating links](./help/Attachments/Creating%20links.gif)
+
+ - Links navigation
+
+ - ![Links navigation](./help/Attachments/Links%20navigation.gif)
+
+ - Automatic links synchronization
+
+ - ![Automatic links synchronization](./help/Attachments/Automatic%20link%20synchronization.gif)
+
+ - Links labeling
+
+ - ![Links labeling](./help/Attachments/Links%20labeling.png)
 
-![Creating links](./help/Attachments/Creating%20links.gif)
+ - Support for short and full links on filename clash
 
-- Notes and images preview on hover and using built-in VSCode Markdown preview 🖼️
+ - ![Support short and full links on filename clash](./help/Attachments/Short%20and%20long%20links%20support%202.png)
+
+- 🖼️ **Notes and images preview**
 
 ![Notes and images preview](./help/Attachments/Notes%20and%20images%20preview.gif)
 
-- Creating notes from links on the fly 🦋
+- 🦋 **Creating notes on the fly**
+
+![Creating notes on the fly](./help/Attachments/Creating%20notes%20from%20links.png)
+
+- **Backlinks panel**
+
+![Backlinks panel](./help/Attachments/Backlinks%20panel.png)
+
+- 🕹 **Commands**
+
+ - "Open today's note" command which creates a note with a title in this format `yyyy-mm-dd` or opens already existing one
+
+ - ![Open today's note command](./help/Attachments/Open%20today's%20note.gif)
+
+ - "Open random note" command which allows your to explore you knowledge base a little bit
+
+ - ![Open random note command](./help/Attachments/Open%20random%20note.gif)
 
-![Creating notes from links](./help/Attachments/Creating%20notes%20from%20links.png)
+## Getting started
 
-- Automatic links synchronization on file move / rename
-- Support for absolute and short links support in case of non-unique filename across workspace
-- Support for link with label `[[your link|your label]]`, it will be rendered as link with `your label` in markdown preview
-- Image and note preview on hovering a link in the text editor
-- Opening note or image from link in markdown preview
-- Backlinks panel
-- "Open today note" command
-- "Open random note command" for exploring already existing notes
+If you want to try out [Memo](https://marketplace.visualstudio.com/items?itemName=svsool.markdown-memo), just install it from the marketplace and open help folder in VSCode.

help/Daily/2020-07-05.md

@@ -1,3 +1,7 @@
 # 2020-07-05
 
-- Started working on [[Memo]] help
+One of my daily notes
+
+Events:
+
+- Started working on Memo help

help/Examples/Demo (Non-Unique)/DemoNote.md

@@ -0,0 +1 @@
+Demo note without content :).

help/Examples/Demo (Non-Unique)/Notes/DemoNote.md

@@ -0,0 +1 @@
+Demo note without content :).

help/Examples/Links sync/SyncNote.md

@@ -0,0 +1 @@
+Rename this note to see how Memo synchronizes links automatically.

help/Features/Automatic link synchronization.md

@@ -0,0 +1,5 @@
+# Automatic link synchronization
+
+Let's reference [[SyncNote]] from the `Examples/Links sync` folder and imagine that you decided to rename `SyncNote` to `HelloWorld`. In this case Memo will synchronize [[SyncNote]] links here in this note and all other files automatically. Try to rename that file yourself or check how synchronization looks like from the picture below.
+
+![[Automatic link synchronization.gif]]

help/Features/Backlinks panel.md

@@ -0,0 +1,7 @@
+# Backlinks panel
+
+Backlinks panel shows how the current note is referenced in other notes.
+
+![[Backlinks panel.png]]
+
+All links are grouped by the filename and marked with `LINE:OFFSET`, so you can see within which line and at which offset certain link is used. Clicking on the filename will bring you to beginning of the file that references the link and clicking on the link itself will bring your cursor to that link in the file.

help/Features/Commands.md

@@ -0,0 +1,6 @@
+# Commands
+
+- Open today's note command which creates a note with a title in this format `yyyy-mm-dd` or opens already existing one instead
+ - ![[Open today's note.gif]]
+- Open random note command which allows your to explore you knowledge base a little bit
+ - ![[Open random note.gif]]

help/Features/Creating links.md

@@ -2,4 +2,6 @@
 
 You can use links to refer to any note in your personal knowledge base such as for instance a daily note [[2020-07-05]] or an image resource ![[Creating links.gif]].
 
-To create a link to any resource you can use `[[]]` notation and for embedding resource to show it in built-in preview (only images supported at the moment) please use `![[]]` notation with `!` in the beginning.
+To create a link to any resource you can use `[[]]` notation and for embedding resource to show it in the built-in preview (only images supported at the moment) please use `![[]]` notation with `!` in the beginning.
+
+You can assign label to the link using `|` pipe notation, as for instance done for [[2020-07-05|The day when I started writing this help]] note.

help/Features/Creating notes from links.md

@@ -1,3 +1,3 @@
 # Creating notes from links
 
-You can automatically create a [[Note]] if does not exist yet just by clicking on the link using `cmd / ctrl + click` or using VSCode built-in "Open Link" command ![[Open link command.png]] which you can bind to a keyboard shortcut. I use `cmd + enter` on my MacBook Pro for that.
+You can automatically create a [[Note]] if does not exist yet just by clicking on the link using `cmd / ctrl + click` or using VSCode built-in "Open Link" command ![[Open link command.png]] which you can bind to a keyboard shortcut. I use `cmd + enter` as a shortcut for opening the links, but you can come up with the one that fits your workflow best.

help/Features/Features.md

@@ -2,3 +2,7 @@
 
 - [[Creating links]]
 - [[Creating notes from links]]
+- [[Short and long links support]]
+- [[Automatic link synchronization]]
+- [[Backlinks panel]]
+- [[Commands]]

help/Features/Short and long links support.md

@@ -0,0 +1,21 @@
+# Short and long (absolute) links support
+
+In case when you have a few notes with the same filename in different directories Memo supports short and long links.
+
+For example, `Examples/Demo (Non-Unique)` folder in the help directory has the following structure:
+
+```
+├── Examples
+│   └── Demo (Non-Unique)
+│   ├── DemoNote.md
+│   └── Notes
+│   └── DemoNote.md
+```
+
+If you want to link `DemoNote.md (#1)` Memo will use a short link like following [[DemoNote]], because this link comes first in the autocomplete results.
+
+![[Short and long links support.png]]
+
+And if you want to link `DemoNote.md (#2)` Memo will use a long (absolute) link like following [[Examples/Demo (Non-Unique)/Notes/DemoNote]].
+
+This simple assumption helps to make links shorter in most cases.

help/README.md

@@ -1,8 +1,10 @@
 # Getting started
 
+This help can be read using any Markdown reader. For instance, GitHub UI, however, don't expect links to work and images to be correctly embedded, and instead, it's recommended to open this help folder using VSCode and Memo.
+
 Memo is a markdown knowledge base with bidirectional links built on top of [VSCode](https:/microsoft/vscode).
 
-One of the main things that Memo enables is creating link in Markdown files. You can create links that refer to the same note, such as this one [[Getting started|Start here]] or refer to any other [[Note]]. Use (cmd or ctrl) + click on the [[Note]] to create a new note to the disk on the fly.
+One of the main things that Memo enables is creating link in Markdown files. You can create links that refer to the same note, such as this one [[README|Start here]] or refer to any other [[Note]]. Use (cmd or ctrl) + click on the [[Note]] to create a new note to the disk on the fly.
 
 Memo supports everything that VSCode Markdown plugin does and many other Markdown plugins from the marketplace. There are [a lot](https://marketplace.visualstudio.com/search?term=tag%3Amarkdown&target=VSCode&category=All%20categories&sortBy=Relevance) of plugins to choose from 🙂. Enjoy discovering those that suits your writing practices most!
 
@@ -12,7 +14,7 @@ I myself do prefer using Memo as a diary and adopted the following structure:
 
 ![[Structure 2.png]]
 
-As you probably noticed, I use `yyyy-mm-dd ` format for naming my daily notes, which makes it easier to refer to certain dates or days throughout my diary. I'm planning to add dates highlight to the editor so that whenever you refer to date via the link for instance [[2020-12-20]] Memo will also provide you with a hint what day and month is it in a human-readable way right next to the link.
+As you probably noticed, I use `yyyy-mm-dd ` format for naming my daily notes, which makes it easier to refer to certain dates or days throughout my diary. I'm planning to add dates highlight to the editor so that whenever you refer to date via the link for instance [[2020-07-05]] Memo will also provide a hint what day and month it is in a human-readable way.
 
 Markdown is a well-known language for its flexibility, especially when it comes to writing and making notes, so you are free to choose your own and unique style of managing a personal knowledge base.