Link Search Menu Expand Document

Commands


Notes

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

Copy Note Ref

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

Copies a reference to the current open document

Lets you quickly create a note reference to the current note.

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

Delete Node

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

Delete a note or schema

Rename Note

  • shortcuts: none

Rename a note and all backlinks

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

Finding Notes

Below is an example of a simple two level hierarchy with notes on various command line interface commands. Use Cmd+L (we are going to use mac keybindings for this tutorial) to bring up the lookup and try some of the following queries.

- cli.tar
- cli.curl
- cli.dig

Creating Notes

While we call it the Lookup Bar, you can also use it to create notes that don’t exist. When you lookup for a note that hasn’t been created, Dendron will create it for you.

To try it yourself, bring up the lookup bar. Type dendron.lookup.hello and hit Enter.

Creating Special Notes

Dendron has builtin notion for certain types of notes with pre-defined hierarchies. These notes can be created by toggling the corresponding note button on the lookup menu or by using the respective builtin shortcuts.

  • values:
    • none (default): create a regular note
    • journal: create a journal note (cmd/ctrl + shift + s)
    • scratch: create a scratch note (cmd/ctrl + shift + j)

Creating Notes with a Selection

If you have text highlighted while creating a new note with a lookup, the new note will be created using the text selected. How the text will be used depends on the dendron.defaultLookupCreateBehavior setting.

  • values:
    • selectionExtract (default): create new note with text from the old note. remove text from the old note
    • selection2link: create new empty note and turn selection into a link referencing the old note

Passing Arguments to Lookup

filterType

  • controls notes shown for lookup
  • options:
    • directChildOnly: filter all notes that are not the direct children of the current note

selectionType

  • controls selection modifier
  • options
    • selectionExtract: selection is extracted to newly created note (default)
    • selection2link: selection ist turned into a link to newly created note

noteType

  • controls what sort of note is created
  • options
    • {none}: create a normal note (default)
    • journal: create a journal note
    • scratch: create a scratch ntoe:

splitType

  • if set, open note in a new split
  • options:
    • horizontal: open in horizontal split

noConfirm

  • if set, select first option from lookup without confirmation
  • type: boolean

value

  • if set, have a custom value for lookup
  • type: string

Passing Arguments Using Keybindings

You can trigger specific lookups using custom key bindings. For example, The following keybinding will trigger lookup set to creating a journal note and turning a selection into a link.

Dendron uses VSCode keybinding functionality to define its own keybindings.

To update your keybindings, open the command prompt and type Open Keyboard Shortcuts.

If you prefer to work with JSON, you can use Open Keyboard Shortcuts (JSON).

You can read more about keybinding syntax here

Tips

Add, Reset and Remove

  • Add: Every command in VSCode can be bound to a keybinding, even if it doesn’t have one
  • Reset: If you want to go back to a default binding, reset it
  • Remove: If you don’t use an existing binding, you can remove it

{
"command": "dendron.lookup",
"key": "cmd+k j",
    "args": {
        "noteType": "journal",
        "selectionType": "selection2link"
    }
}

Deleting Notes

To delete dendron.lookup.hello, use the Cmd+Shift+D shortcut on the note that you want to delete. Alternatively, you can also launch the Command Bar and type Dendron: Delete Node

Lookup (Journal Note)

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

Initiate note lookup with journal note pre-selected

Finding Notes

Below is an example of a simple two level hierarchy with notes on various command line interface commands. Use Cmd+L (we are going to use mac keybindings for this tutorial) to bring up the lookup and try some of the following queries.

- cli.tar
- cli.curl
- cli.dig

Creating Notes

While we call it the Lookup Bar, you can also use it to create notes that don’t exist. When you lookup for a note that hasn’t been created, Dendron will create it for you.

To try it yourself, bring up the lookup bar. Type dendron.lookup.hello and hit Enter.

Creating Special Notes

Dendron has builtin notion for certain types of notes with pre-defined hierarchies. These notes can be created by toggling the corresponding note button on the lookup menu or by using the respective builtin shortcuts.

  • values:
    • none (default): create a regular note
    • journal: create a journal note (cmd/ctrl + shift + s)
    • scratch: create a scratch note (cmd/ctrl + shift + j)

Creating Notes with a Selection

If you have text highlighted while creating a new note with a lookup, the new note will be created using the text selected. How the text will be used depends on the dendron.defaultLookupCreateBehavior setting.

  • values:
    • selectionExtract (default): create new note with text from the old note. remove text from the old note
    • selection2link: create new empty note and turn selection into a link referencing the old note

Passing Arguments to Lookup

filterType

  • controls notes shown for lookup
  • options:
    • directChildOnly: filter all notes that are not the direct children of the current note

selectionType

  • controls selection modifier
  • options
    • selectionExtract: selection is extracted to newly created note (default)
    • selection2link: selection ist turned into a link to newly created note

noteType

  • controls what sort of note is created
  • options
    • {none}: create a normal note (default)
    • journal: create a journal note
    • scratch: create a scratch ntoe:

splitType

  • if set, open note in a new split
  • options:
    • horizontal: open in horizontal split

noConfirm

  • if set, select first option from lookup without confirmation
  • type: boolean

value

  • if set, have a custom value for lookup
  • type: string

Passing Arguments Using Keybindings

You can trigger specific lookups using custom key bindings. For example, The following keybinding will trigger lookup set to creating a journal note and turning a selection into a link.

Dendron uses VSCode keybinding functionality to define its own keybindings.

To update your keybindings, open the command prompt and type Open Keyboard Shortcuts.

If you prefer to work with JSON, you can use Open Keyboard Shortcuts (JSON).

You can read more about keybinding syntax here

Tips

Add, Reset and Remove

  • Add: Every command in VSCode can be bound to a keybinding, even if it doesn’t have one
  • Reset: If you want to go back to a default binding, reset it
  • Remove: If you don’t use an existing binding, you can remove it

{
"command": "dendron.lookup",
"key": "cmd+k j",
    "args": {
        "noteType": "journal",
        "selectionType": "selection2link"
    }
}

Deleting Notes

To delete dendron.lookup.hello, use the Cmd+Shift+D shortcut on the note that you want to delete. Alternatively, you can also launch the Command Bar and type Dendron: Delete Node

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

Finding Notes

Below is an example of a simple two level hierarchy with notes on various command line interface commands. Use Cmd+L (we are going to use mac keybindings for this tutorial) to bring up the lookup and try some of the following queries.

- cli.tar
- cli.curl
- cli.dig

Creating Notes

While we call it the Lookup Bar, you can also use it to create notes that don’t exist. When you lookup for a note that hasn’t been created, Dendron will create it for you.

To try it yourself, bring up the lookup bar. Type dendron.lookup.hello and hit Enter.

Creating Special Notes

Dendron has builtin notion for certain types of notes with pre-defined hierarchies. These notes can be created by toggling the corresponding note button on the lookup menu or by using the respective builtin shortcuts.

  • values:
    • none (default): create a regular note
    • journal: create a journal note (cmd/ctrl + shift + s)
    • scratch: create a scratch note (cmd/ctrl + shift + j)

Creating Notes with a Selection

If you have text highlighted while creating a new note with a lookup, the new note will be created using the text selected. How the text will be used depends on the dendron.defaultLookupCreateBehavior setting.

  • values:
    • selectionExtract (default): create new note with text from the old note. remove text from the old note
    • selection2link: create new empty note and turn selection into a link referencing the old note

Passing Arguments to Lookup

filterType

  • controls notes shown for lookup
  • options:
    • directChildOnly: filter all notes that are not the direct children of the current note

selectionType

  • controls selection modifier
  • options
    • selectionExtract: selection is extracted to newly created note (default)
    • selection2link: selection ist turned into a link to newly created note

noteType

  • controls what sort of note is created
  • options
    • {none}: create a normal note (default)
    • journal: create a journal note
    • scratch: create a scratch ntoe:

splitType

  • if set, open note in a new split
  • options:
    • horizontal: open in horizontal split

noConfirm

  • if set, select first option from lookup without confirmation
  • type: boolean

value

  • if set, have a custom value for lookup
  • type: string

Passing Arguments Using Keybindings

You can trigger specific lookups using custom key bindings. For example, The following keybinding will trigger lookup set to creating a journal note and turning a selection into a link.

Dendron uses VSCode keybinding functionality to define its own keybindings.

To update your keybindings, open the command prompt and type Open Keyboard Shortcuts.

If you prefer to work with JSON, you can use Open Keyboard Shortcuts (JSON).

You can read more about keybinding syntax here

Tips

Add, Reset and Remove

  • Add: Every command in VSCode can be bound to a keybinding, even if it doesn’t have one
  • Reset: If you want to go back to a default binding, reset it
  • Remove: If you don’t use an existing binding, you can remove it

{
"command": "dendron.lookup",
"key": "cmd+k j",
    "args": {
        "noteType": "journal",
        "selectionType": "selection2link"
    }
}

Deleting Notes

To delete dendron.lookup.hello, use the Cmd+Shift+D shortcut on the note that you want to delete. Alternatively, you can also launch the Command Bar and type Dendron: Delete Node

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


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 https://discordapp.com/channels/717965437182410783/743194856788328497/743195382795993291

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:
    • mac: cmd+shift+right
    • key: ctrl+shift+right
    • when: editorFocus

Go to the next sibling

Go Previous Sibling

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

Go to the previous sibling

Go Down

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

Go down the hierarchy


Workspace

Initialize Workspace

  • shortcuts: none

Create a new workspace

Change Workspace

  • shortcuts: none

Change into existing workspace

Dendron will create a dendron.code-workspace file in specified directory and then open the workspace (if a workspace file already exists, it will use that). It will also create a root.md file in that directory if it doesn’t exist (currently this is part of the internal working of dendron).

Dendron does not delete or overwrite any files during the Change Workspace operation.

Show Help

  • shortcuts: none

Dendron will open your current browser to the cheatsheet page.


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.

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


Publishing

Publish

  • shortcuts: none

Build, commit and publish your notes with a single command


Lookup


Dev

Doctor

  • shortcuts: none

Auto fix issues with frontmatter

This makes sure your workspace is up to date. It will execute the following actions:

  • 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

Dendron:Dev: Open Logs

  • shortcuts: none

Open Dendron logs for current session