Links

Summary

Create links to various locations using basic and extended syntax.

Dendron provides many ways to create links between notes and assets. This range from regular markdown links to extended syntax such as wikilinks, file links, and much more.

Features

Whether the resource you're linking to is on your hard drive or on the internet, Dendron lets you quickly create a link to it.

See at a glance all notes that link to the current note with backlinks.

Hover over links to get rich previews to get the context before opening navigating to the link.

Use autocomplete or the Dendron: Insert Note Link command to create a link to an existing note. You can also use Dendron: Copy Note Link to create a link from an open note or file.

Navigate through links without leaving the keyboard using Dendron: Go to. If the link is a website or a custom file format, Dendron will use your system default program to open the link

Connect the docts using the Graph View

Getting Started

Here is a list of resource that will help you start using links in your notes:

Components

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

Details

Getting started

Alias

By default, wikilinks are rendered as the linked note's title when viewed by the note preview or when published. You can change how wikilinks are rendered by giving them an alias. To give an alias to a wikilink, simply add the alias in front of the wikilink followed by a | like so:

Wikilinks are [[awesome|some-awesome-note]]!

Wikilinks without alias are also called Naked Links

Autocomplete

Wikilink Autocomplete

  • Type [[ to trigger the autocomplete
  • Link to specific sections of notes using the [[wiki link#header]] syntax
  • Use the VS Code intellisense shortcut to trigger the autocomplete

Syntax highlighting

Wikilinks also have support for syntax 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.

Previewing the note that is linked

Wikilink Hover

You can preview the content of the note that the link is pointing to by hovering your mouse over the wikilink.

A block link is a Wiki Link that links to Block Anchors.

Details

Getting started

Linking to anchors within the same note

When linking to a block anchor within the same note, you can create a wikilink to the anchor like so:

Ab voluptatem commodi maiores.
Nemo qui voluptatem dolores. ^my-paragraph

Let's look back at that paragraph: [[#^my-paragraph]]

Linking to anchors in a different note

When linkg to a block anchor in a different note, you can create a regular wikilink to said note and append the block anchor reference at the end.

In note foo:

Ab voluptatem commodi maiores.
Nemo qui voluptatem dolores. ^my-paragraph

In note bar:

Let's look back at that paragraph: [[foo#^my-paragraph]]

You can create block links by using Dendron: Copy Note Link while placing your cursor on top of the anchor you want to create a link for.

A file link is a Wiki Link that links to files in your workspace that are not Dendron notes, or not in a Dendron vault.

Details

Getting started

The easiest way to link to a file is using the Copy Note Link command, which will automatically create a link for you.

Similar to notes, Copy Note Link command will create a Block Anchors for you if you have a region of text selected.

To manually create file links, you need to write the relative path to the file in a Wiki Link

The path should be relative to where your dendron.yml file is located.

For example, if the root of your workspace contains dendron.yml and a folder called src in your project, you can write [[src/index.js]].

Alternatively, if you are linking to a file inside the assets folder of a vault, you can type [[assets/example.py]] to link to it.

A child link is a link to a child note created at the end of the note when you view your notes using note preview, or in a published site.

Details

Children

Getting started

Dendron will automatically generate a section called Children at the end of the note by default.

This only works on a per-note basis. In the future we plan to add the ability to disable this globally.

This behavior can be disabled in note preview by adding the following frontmatter of each note you want this to be disabled:

config:
  global:
    enableChildLinks: false

This behavior can be disabled in published notes by adding the following frontmatter of each note you want this to be disabled:

nav_exclude_children: true

See nav_exclude_children for more information.

Backlinks are links that point to the current note

Details

Getting started

The backlinks panel is part of the Sidebar

See Backlinks Panel for more information.

Features

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

The link candidate feature is currently disabled by default. See Explicit and Candidate Backlinks to learn 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.

Wikilinks that specify which vault it belongs to in a multi vault workspace.

Details

Getting started

You can turn a regular link into a cross vault link by adding dendron://$vaultName/ prefix where $vaultName is the name of your vault.

Here are some examples of different types of wikilinks with the vault prefix included:

This is a cross vault wikilink to the note foo that is in the vault named vault:

[[dendron://vault/foo]]

This is a cross vault wikilink to the note foo that is in the vault named vault, that has an alias:

[[Foo Note|dendron://vault/foo]]

This is a cross vault wikilink to the header Header1, in the note foo, that is in the vault named vault, that has an alias:

[[Foo Note|dendron://vault/foo#header1]]

You can also use cross vault links for note references like so:

![[dendron://vault/foo]]

Markdown links are the default way to create links using Markdown.

Detail

Since Markdown links are the defacto way of creating links, they could be recognized by any application that understands Markdown.

Getting started

Markdown links can be used for local files or web addresses (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.

Children


Backlinks