Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
levirs565 committed Jun 11, 2023
1 parent b9798fe commit c46e9a9
Showing 1 changed file with 69 additions and 27 deletions.
96 changes: 69 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,84 @@ Obsidian Dendron Tree add tree for exploring [Dendron](https://www.dendron.so/)

Features:

- Dendron Tree
To view the Dendron Tree you can select "Open Dendron Tree" in Ribbon bar.
- Dendron Tree, browse note easily using tree
- Lookup
- Automatically generate frontmatter on new file
- Multi vault support
- Custom resolver and renderer for link and ambed

Note with orange circle indicator
(![Note without corresponding file](images/note-without-file.png)) is note that does not have
corresponding file.
## Dendron Tree

To open note file you can select note name in tree. This also expand the note in tree.
To view the Dendron Tree you can select "Open Dendron Tree" in Ribbon bar.

To expand and collapse note you can select arrow (![Note arrow](images/arrow.png)) in left of
note.
Note with orange circle indicator (![Note without corresponding file](images/note-without-file.png))
is note that does not have corresponding file.

You can right click on Desktop or long press on Mobile note to open note menu. Note menu will have
following item:
To open note file you can select note name in tree. This also expand the note in tree.

- "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.
To expand and collapse note you can select arrow (![Note arrow](images/arrow.png)) in left of note.

- Lookup
![Lookup note](images/lookup.png)
You can right click on Desktop or long press on Mobile note to open note menu. Note menu will have
following item:

To lookup note you can run command "Dendron Tree: Lookup Note". With this you can open and delete
note.
- "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 new](images/lookup-new.png)
## Lookup

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.
![Lookup note](images/lookup.png)

![Create note file for file-less note](images/create-new-existing.png)
To lookup note you can run command "Dendron Tree: Lookup Note". With this you can open and delete
note.

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.
![Create new](images/lookup-new.png)

> It's reccomended to always input Dendron path in lookup modal.
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.

![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.

> It's reccomended 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.

## 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.

Here are the brief differences between Dendron and Obsidian regarding WikiLink.

This is format of Obsidian WikiLink:

```
[[href|title]]
```

Whereas, this is 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 Dendron, to target 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)

0 comments on commit c46e9a9

Please sign in to comment.