Links

Summary

Dendron supports many ways of linking notes and files.

Types

  • Markdown links (can link to any file):
    • [link text](dendron.note.name.md) -> link text
    • [link text](./path/to/filename.md) -> link text
    • [link text](assets/filename.pdf) -> link text
  • Wiki links: [[dendron.note.name]] -> dendron.note.name (Private)
  • Image links: ![image alt text](http://image.url/or/path/to/image)

Concepts

Note Files

A note file is a Dendron Markdown note.

Regular Files

Regular files are any assets that are not Dendron Markdown notes.

Features

Summary

Wiki links are surrounded by the two pairs of opening and closing brackes (eg. [[hello]])

Features

Autocomplete

Wikilink Autocomplete

  • type [[ to trigger the autocomplete
  • link to specific sections of notes using the [[wiki link#header]] syntax
    • NOTE: relative links will not go to the anchor if clicked on the preview, in that case, it becomes a normal link to the file
    • NOTE2: doesn't work when exported through a pod
  • use the VS Code intellisense shortcut to trigger the autocomplete

Highlights

Wiki links also have support for highlighting in the editor. Existing notes will be highlighted in blue, and missing notes will be highlighted in yellow. The exact shade of color depends on your theme.

Hovers

Wikilink Hover

Summary

A sprout is a feature or process that has gone through a few initial iterations. It is still subject to change but is unlikely to be removed.

Qualities

  • hard things are not possible to do
  • feature does not work with multi vault

You can link to files in your workspace that are not notes (or not in a vault) using wikilinks. The easiest way to link to a file is using the Copy Note Link command, which will automatically create a link for you. As with note files, copy note link will create a Block Anchor for you if you have a region of text selected.

Otherwise, you need to write inside a wikilink the relative path to the file from where your dendron.yml file is located. For example, if the root of your workspace contains dendron.yml and a src folder, you can write [[src/index.js]]. Alternatively, if you are linking to a file inside the assets folder of a vault, you can simply type [[assets/example.py]] to link to it.

When you publish your notes, Dendron shows all children of the note at the bottom.

Backlinks are links that point to the current note.

There are currently two types of backlinks available in the Backlinks view: Linked and Candidates.

Linked backlinks are regular wiki links that are pointing to the current note.

  • NOTE: The link candidate feature of the backlinks panel is currently disabled by default. 'Accessing the Backlinks view' section below goes over how to enable it.

Candidate backlinks are plain text words that match the name of the current note, which can potentially be converted into a (linked) backlink.

Dendron has a backlinks panel which shows all notes with links to the current note. This will also show up underneath children links on published pages.

Backlinks Dark

You can find further documentation about it here.

For regular links, you can highlight the link and use > Dendron: Open Link to open the file using your operating system default for that file. This also applies to opening paths to folders.

Cross vault links are a way of exactly specifying a note in a multi vault workspace. You can turn a regular link into a cross vault link by adding dendron://$vaultName/ prefix where $vaultName is the name of your vault.

Some examples:

  • regular wiki link: [[dendron://vault/foo]]
  • wiki link with alias: [[Foo Note|dendron://vault/foo]]
  • relative link: [[Foo Note|dendron://vault/foo#header1]]

You can also use cross vault links for note references.

  • note ref: ![[dendron://vault/foo]]

Markdown links can be used for local files and stuff on the internet (websites, images, blogs etc.). The Markdown Shortcuts: Toggle hyperlink command makes this operation really easy. You can even bind this to a shortcut key combination. We'd recommend using 'cmd/ctrl + K' to get the usual application behavior or 'cmd/ctrl + U' if you want to continue using ctrl+k as part of the usual VS Code combo operation.

Commands

Convert selected link to other types of links or plaintext.


Children
  1. Wiki Link

Backlinks