Link Search Menu Expand Document

Commands

Lookup

Contribute

  • shortcuts: none

Become an environmentalist and keep Dendron sustainable

This command takes you to Dendron's Environmentalist plans. Environmentalists are users that can support Dendron financially through a monthly contribution. Environmentalist get access to insider builds, priority support, and access to exclusive dev channels.

Notes

Browse Note

  • shortcuts: None

Open the github repository (if it exists) of the current note. If you have a multi vault workspace with different git repositories, this command will

Create Daily Journal Note

  • shortcuts:
    • key: ctrl+shift+i
    • mac: cmd+shift+i
    • when: editorFocus

Create a global journal note

  • shortcuts:
    • key: ctrl+shift+c
    • mac: cmd+shift+c
    • when: editorFocus

Copy wiki link to note. The title of the note will be applied as the note alias. If you highlight a header, dendron will create a relative link to the header with the alias set to the header value.

You can also highlight any line of text, and Dendron will create a link to it by inserting a block anchor, or copy an existing anchor.

If you use this command in a multi vault workspace, Dendron will create a cross vault link to the note in question.

Copy Note Ref

  • shortcuts:
    • key: ctrl+shift+r
    • mac: cmd+shift+r
    • when: editorFocus

Copies a reference to the current open document

This lets you quickly create a note reference to the current note.

Header Selection

If you have a header selected while running this command, it will copy the note ref with the selected header to the next note ref.

Block Selection

If you have some text selected, Dendron can insert block anchors to reference the region you have selected.

Range Selection

If you highlight multiple blocks, Dendron can create a range selection that spans the blocks selected. Watch the following video starting at the 10s mark for an example.

MultiVault

If you use this command in a multi vault workspace, Dendron will create a cross vault link to the note in question.

Delete Node

  • shortcuts:
    • key: ctrl+shift+d
    • mac: cmd+shift+d

Delete a note or schema

Insert Note

Insert the contents from a note into another note. You can configure a starting hierarchy for this command. Useful if you designated a hierarchy (eg. templates) for insertions.

Insert the note link into the current document using lookup.

Move Note

Move a note. Also includes option to move a note between vaults

Transform URL in clipboard to nicely formatted markdown link

Random Note

Navigates to a random note in the workspace. By default, all notes are included in the set that can be navigated to with this command. This can be adjusted with the randomNote setting in the Dendron Config (see Configure (yaml)).

# Sample configuration in dendron.yml:
randomNote:
    include:
        - alpha
        - beta.foo
    exclude:
        - alpha.bar

This pattern would specify a set including all notes under alpha except for notes in the alpha.bar hierarchy. The set would also include notes under beta.foo*.

  • If include is not specified, then the include matching pattern will match all notes.
  • exclude takes precedence over include, so if the patterns are identical, no notes will match.

Rename Note

  • shortcuts: none

Rename a note and all backlinks.

If the title is the same as what Dendron would autogenerate (kebab-case capitalized), then refactor will change the title as well. Otherwise, it will preserve the existing title.

Show Preview

  • shortcuts:
    • windows: windows+ctrl+p
    • mac: cmd+ctrl+p

Show Markdown Preview

Lookup

  • shortcuts:
    • mac: cmd+L
    • key: ctrl+l

Initiate note lookup

From dendron.topic.lookup
Go to text →

To work with notes, Dendron uses lookups. Lookups help you create, find, and organize your notes. You can watch the following video to see some of the things you can do with lookups.

Details

Behind the scenes, lookup uses fusejs to do fuzzy string matching based on the note hierarchy. You can see our parameters here.

Scoring is explained here.

You can see the pseudo code for how fusejs integrates with lookup here.

Lookup (Journal Note)

  • shortcuts:
    • key: ctrl+shift+j
    • mac: cmd+shift+j
    • args: {'noteType': 'journal'}

Initiate note lookup with journal note pre-selected

Lookup (Scratch Note)

  • shortcuts:
    • key: ctrl+shift+s
    • mac: cmd+shift+s
    • args: {'noteType': 'scratch', 'selectionType': 'selection2link'}

Initiate note lookup with scratch note pre-selected

Lookup Schema

  • shortcuts:
    • mac: cmd+shift+L
    • key: ctrl+shift+l

Initiate schema lookup

  • shortcuts: none

Open link to external file (eg. pdf, .mov, etc) use system default. Relative files paths will be opened relative to the vault that the note is in.

Hierarchies

Reload Index

  • shortcuts: none

Reload the index. Necessary for Dendron to pick up on schema changes.

Archive Hierarchy

  • shortcuts: none

Move current note and all children under the archive hierarchy

This is a convenience method around Refactor Hierarchy for the case of archiving hierarchies you are no longer using. For example, if you were currently at pro.foo, running Archive Hierarchy would be equivalent to running Refactor Hierarchy with the following arguments:

  • matcher: pro.foo
  • replacement: archive.pro.foo

Refactor Hierarchy

  • shortcuts: none

Update hierarchy using regex

Like Rename Note but works on an entire hierarchy of notes. This command takes two arguments:

  • matcher: regex that matches text you want to capture for replacement
  • replacer: regex that represents text you want to use as replacement

After running the command, you will be taken to a preview that shows all files that will be affected. You will be given an option in a dropdown to either proceed with the refactor or cancel the operation.

  • NOTE: Dendron will warn you if refactoring will overwrite existing files. You will need to either change your replacer or move the affected files before Dendron will perform a refactor

Refactor Hierarchy is a huge time-saver: https://discordapp.com/channels/717965437182410783/743194856788328497/743195382795993291

Goto Note

  • shortcuts:
    • key: ctrl+enter
    • when: editorFocus

Goto to the note under the cursor, creating it if it doesn't exist.

Go Up

  • shortcuts:
    • mac: cmd+shift+up
    • key: ctrl+shift+up
    • when: editorFocus

Go to closet non-stub parent of the currently open note

Go Next Sibling

  • shortcuts:
    • key: ctrl+shift+]
    • when: editorFocus

Go to the next sibling

Siblings with numeric names will be sorted numerically, whereas siblings with alphabetical names will be sorted alphabetically when determining the next sibling.

Go Previous Sibling

  • shortcuts:
    • key: ctrl+shift+[
    • when: editorFocus

Go to the previous sibling

Siblings with numeric names will be sorted numerically, whereas siblings with alphabetical names will be sorted alphabetically when determining the previous sibling.

Go Down

  • shortcuts:
    • mac: cmd+shift+down
    • key: ctrl+shift+down
    • when: editorFocus

Go down the hierarchy

Hooks

Hook Create

Create a custom hook to trigger during Dendron's lifecycle. This command takes two parameters:

  • hookName: name of your hook
  • hookFilter: a glob pattern that filters what notes your hook applies to
    • default: *, apply hook to all notes by default
  • hookType: where to attach the hook (coming soon - we only support onCreate at the moment)
    • types: onCreate|onDelete|onChange
    • default: onCreate

Hook Delete

Delete a custom hook. Will remove the hook from dendron.yml and optionally, remove {workspace}/hooks/{hookName}.js

Parameters:

  • hookName: name of the hook to remove
  • shouldDeleteScript: whether you should also delete the hook script

Workspace

Disable Telemetry

Disable telemetry across all workspaces with Dendron

Enable Telemetry

Enable telemetry across all workspaces with Dendron

Vault Add

From dendron.ref.vaults
Go to text →
  • shortcuts: none

Add a new vault to your workspace.

When you add a vault, you can choose between adding a local vault or a remote vault.

Vault Remove

From dendron.ref.vaults
Go to text →
  • shortcuts: none

Remove a vault

Remove a vault from your workspace. Note that the underlying files will not be deleted - the vault will lose its association with your workspace.

Initialize Workspace

  • shortcuts: none

Create a new workspace

Change Workspace

  • shortcuts: none

Change into existing workspace

Snapshot Vault

  • shortcuts: none

Create a snapshot of your vault

Takes a snapshot of your entire vault, including assets. This command will ignore version control folders like .git when making a snapshot. Snapshots are saved under {workspace}/snapshots/{timestamp}

Restore Vault

  • shortcuts: none

Restore your vault from a snapshot

Restores your vault based on a snapshot. When restoring, it will over-write any notes that have the same name as notes in the snapshot. It will ignore version control directories like .git when restoring your vault

Show Help

  • shortcuts: none

Dendron will open your current browser to the cheatsheet page.

Configure (yaml)

  • shortcuts: none

Modify Dendron Config as raw YAML

Configure

  • shortcuts: none

Modify Dendron Config using Dendron UI

Workspace: Add and Commit

From dendron.ref.workspace
Go to text →

Add and commit all notes across all vaults to git.

Workspace: Sync

From dendron.ref.workspace
Go to text →

Synchronizes all notes across all vaults with git. Any changes you made will be pushed back to remote, and any changes in the remote will be pulled.

In more detail: Dendron will first commit all your changes, then pull changes from the remote, and finally push everything back to the remote. This workflow is good in most cases: private notes, internal shared vaults, or your personal writings. This workflow doesn't work as well in some cases however, so we offer per-vault configuration options which you can use to adjust how your notes are synchronized.

You can set these configuration options in your dendron.yml, either for each vault with the sync option, or for all workspace vaults with the workspaceVaultSync option. The configuration will look like this:

... rest of your dendron.yml
workspaceVaultSync: noPush
vaults:
    -
        fsPath: my-website
        sync: noCommit
        remote:
            type: git
            url: 'git@github.com:my-username/my-website.git'
    -
        fsPath: my-notes
        sync: sync
        type: git
            url: 'git@github.com:my-username/my-notes.git'

configuration options

sync

Dendron will try to synchronize everything: Dendron will first commit all your changes, then pull changes from the remote, and finally push everything back to the remote. This is the default for regular vaults.

noCommit

Pull and push updates if the workspace is clean, but don't commit. You manually commit your local changes, but automatically share them once you committed. This is good for vaults where you want to write a meaningful commit message and control what is being committed, for example a shared knowledge base or wiki. This is the default for Workspace Vaults.

noPush

Commit any changes and pull updates, but don't push. You can watch the repository and make local changes without sharing them back. This is good if you want to watch the updates in a vault and maybe even note your own thoughts in the vault without sharing them, for example an organization handbook that you don't want to edit yourself.

skip

Don't do any synchronization. This may be useful if you use some other tool to synchronize this vault.

Pods

Build Pod

  • shortcuts: none

Build your notes for export. Currently, only export to github pages is supported.

Configure Pod

  • shortcuts: none

Update your pod configuration

Import Pod

  • shortcuts: none

Import notes from an external data source. Currently, only the local file system is supported

Export Pod

  • shortcuts: none

Export notes to an external data source. Currently only JSON is supported.

Publish Pod

  • shortcuts: none

Publish your note to a different format/location

Copy Note URL

  • shortcuts:
    • mac: cmd+shift+u
    • windows: ctrl+shift+u

Get URL of current note from published site

If you highlight a header, will copy the url with the header set as the anchor

The url is taken from the siteUrl property.

Misc

Paste File

Takes the path currently in the clipboard, copies the file into {vault}/assets, and inserts markdown link in the current note. This is the file equivalent of Dendron's Paste Image command

Note that most file types won't be natively supported in the preview. You'll need to use the vscode built-in > Open Link command to open the file.

If you are on macOs, you can find instructions for getting the path to the current file here

Publishing

Publish

  • shortcuts: none

Build, commit and publish your notes with a single command

  • NOTE: this is mean for v1 publishing. V2 publishing currently does not have a publish command.

Site Build

  • shortcuts: none

Build your notes using publishing v2

This command works by running dendron-cli in the background.

Site Preview

  • shortcuts: none

Preview your notes on localhost using publishing v2.

This command works by running dendron-cli in the background.

Dev

Doctor

  • shortcuts: none

Automatically fix various issues with Dendron.

You can pick among various actions for the doctor to perform.

  • Doctor performs it's actions on the entire workspace by default
  • You can toggle this behavior with the Change Scope button on the top right corner of panel so that it runs only on the active open document.
  • This requires you to have a note open and in focus before running the doctor command.

Actions

  • fixFrontmatter
    • Add ids and titles to the frontmatter of all notes that are missing it
    • Setup a docs folder if it doesn't exist. Required if you want to publish your notes

h1ToTitle
  • Remove initial h1 header and use it to replace contents of title field in frontmatter
h1ToH2
  • Convert all initial h1 header to h2 header
removeStubs:
  • Remove all stub docs
oldNoteRefToNew
  • Convert legacy note refs to new style note refs
createMissingLinkedNotes

  • This doctor action is currently only supported in file scope.

  • Create notes that do not exist yet but has a wikilink to it.

  • A preview pane will appear with the notes that will be created before proceeding.

Dump State

  • shortcuts: none

Dump internal state of Dendron inside logs

This is useful when diagnosing issues in Dendron

Dendron:Dev: Open Logs

  • shortcuts: none

Open Dendron logs for current session

Dendron:Dev: Diagnostics Report

  • shortcuts: none

Copy last 3000 lines of all logs and config to clipboard. Use when submitting an issue to Dendron