generated from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,89 +1,96 @@ | ||
# Obsidian Dendron Tree | ||
|
||
Obsidian Dendron Tree add tree for exploring [Dendron](https://www.dendron.so/) note. | ||
Obsidian Dendron Tree adds a tree for exploring [Dendron](https://www.dendron.so/) notes. Features: | ||
|
||
![Dendron Tree](images/dendron-tree.png) | ||
|
||
Features: | ||
|
||
- Dendron Tree, browse note easily using tree | ||
- Dendron Tree, browse notes easily using tree | ||
- Lookup | ||
- Automatically generate frontmatter on new file | ||
- Automatically generate frontmatter on a new file | ||
- Multi vault support | ||
- Custom resolver and renderer for link and ambed | ||
- Custom resolver and renderer for link and embed | ||
|
||
## Dendron Tree | ||
|
||
To view the Dendron Tree you can select "Open Dendron Tree" in Ribbon bar. | ||
To view the Dendron Tree you can select "Open Dendron Tree" in the Application's Ribbon bar. | ||
|
||
Note with orange circle indicator (![Note without corresponding file](images/note-without-file.png)) | ||
is note that does not have corresponding file. | ||
A note with an orange circle indicator | ||
(![Note without corresponding file](images/note-without-file.png)) is a note that does not have a | ||
corresponding file. | ||
|
||
To open note file you can select note name in tree. This also expand the note in tree. | ||
To open a note file you can select the note name in the tree. This also expands the note in the | ||
tree. | ||
|
||
To expand and collapse note you can select arrow (![Note arrow](images/arrow.png)) in left of note. | ||
To expand and collapse a note you can select arrow (![Note arrow](images/arrow.png)) on the left of | ||
the note. | ||
|
||
You can right click on Desktop or long press on Mobile note to open note menu. Note menu will have | ||
following item: | ||
You can right-click a note on a Desktop or long-press the note on a Mobile to open the note's menu. | ||
Note menu will have the following item: | ||
|
||
- "Create Current Note". This will create file for selected note. This only show when note does not | ||
have corresponding file. | ||
- "Create New Note". This will open Lookup with selected note's path as initial prompt. You can see | ||
lookup documentation on how to use it. | ||
- "Delete Note". This will delete selected note file. This only show when note have corresponding | ||
file. | ||
- "Create Current Note". This will create a file for the selected note. This only show when the note | ||
does not have a corresponding file. | ||
- "Create New Note". This will open Lookup with the selected note's path as the initial prompt. You | ||
can see lookup documentation on how to use it. | ||
- "Delete Note". This will delete the selected note file. This only show when the note has a | ||
corresponding file. | ||
|
||
## Lookup | ||
|
||
![Lookup note](images/lookup.png) | ||
|
||
To lookup note you can run command "Dendron Tree: Lookup Note". With this you can open and delete | ||
note. | ||
To lookup a note you can run "Dendron Tree: Lookup Note" command. With this, you can open and delete | ||
a note. | ||
|
||
![Create new](images/lookup-new.png) | ||
|
||
You can create note by inputting Dendron path that does not exist. Then you will get "Create New" | ||
item. Select this item to create new note. | ||
You can create a note by inputting a Dendron path that does not exist. Then you will get "Create | ||
New" item. Select this item to create a new note. | ||
|
||
![Create note file for file-less note](images/create-new-existing.png) | ||
|
||
You can also select note that does not have corresponding file. Item that when is selected create | ||
new note is indicated by `+` icon at right. | ||
You can also select a note that does not have a corresponding file. An item that when selected will | ||
create a new note is indicated by + icon at the right. | ||
|
||
> It's reccomended to always input Dendron path in lookup modal. | ||
> It's recommended to always input Dendron path in lookup modal. | ||
## Multi Vault | ||
|
||
You can add or remove vault in Plugin Settings. You must specify vault path and vault name. | ||
You can add or remove a vault in Plugin Settings. You must specify the vault path and vault name. | ||
|
||
## Custom Resolver and Renderer (Disabled by Default) | ||
|
||
Dendron and Obsidian have different format and capability for ref/embed and wikilink. When this | ||
feature enabled, all wikilink and embed will forced to render using Dendron format. This also | ||
override link hover functionality. | ||
For embed/ref, Dendron format are extenstion for Obsidian format. You can see Dendron documentation | ||
about [Note Reference] | ||
|
||
Dendron and Obsidian have different formats and capabilities for ref/embed and wikilink. When this | ||
feature is enabled, all wikilink and embed will be forced to render using Dendron format. This also | ||
overrides link hover functionality. | ||
|
||
Here are the brief differences between Dendron and Obsidian regarding WikiLink. | ||
|
||
This is format of Obsidian WikiLink: | ||
This is the format of Obsidian WikiLink: | ||
|
||
``` | ||
[[href|title]] | ||
``` | ||
|
||
Whereas, this is format of Dendron WikiLink: | ||
Whereas, this is the format of Dendron WikiLink: | ||
|
||
``` | ||
[[title|href]] | ||
``` | ||
|
||
In Obsidian, if title for wikilink is not specified then the link will be used as the title. But, in | ||
Dendron, note target's title will be used as the title. | ||
In Obsidian, if the title for wikilink is not specified then the link will be used as the title. | ||
But, in Dendron, note target's title will be used as the title. | ||
|
||
In Dendron, to target note in another vault we must use special syntax like this: | ||
In Dendron, to target a note in another vault we must use special syntax like this: | ||
|
||
``` | ||
dendron://vault_name/note_path | ||
``` | ||
|
||
For embed/ref, Dendron format are extenstion for Obsidian format. You can see Dendron documentation | ||
about [Note Reference](https://wiki.dendron.so/notes/f1af56bb-db27-47ae-8406-61a98de6c78c) | ||
For embed/ref, Dendron format is an extension of the Obsidian format. You can see Dendron | ||
documentation about | ||
[Note Reference](https://wiki.dendron.so/notes/f1af56bb-db27-47ae-8406-61a98de6c78c) |