Dendrons Config

We are currently in the middle of a major overhaul of configuration namespaces, and is subject to change in a weekly basis. All configurations described in this document will gradually be marked as "deprecated" as we move them to a better place.

Summary

dendron.yml located at the root of your workspace.

This file can be accessed using these Commands

Configure (yaml)

  • shortcuts: none

Modify Dendron Config as raw YAML

Configure

  • shortcuts: none

Modify Dendron Config using Dendron UI

Legend

  • default: the default value of a config
  • status: see status docs
  • frontmatter: this option can be set using the note frontmatter

General

defaultInsertHierarchy

This setting is scheduled for deprecation ๐Ÿ“†

Use initialValue instead.

Execute Insert Note with the hierarchy prefilled.

generateChangelog

  • default: false
  • status: experimental ๐Ÿšง

Turn on to enable changelogs

hierarchyDisplayTitle

  • default: Children

Controls the title for children links in published sites

lookupConfirmVaultOnCreate

This setting is scheduled for deprecation ๐Ÿ“†

Use confirmVaultOnCreate instead.

With this set, you will be prompted to select the vault location each time you create a note when you have multiple vaults in your workspace.

lookupDontBubbleUpCreateNew

  • default: false

With this set to true: Create new will NOT bubble up to the top when using Note Lookup. Use this setting when your workflow largely consists of lookups and you want to keep Create new as the last entry in the look up results.

mermaid

  • default: false

Turn on to enable mermaid support

noCaching

Disable dendron caching

noLegacyNoteRef

  • default: true

Disable dendron legacy note refs

noTelemetry

Disable telemetry

hierarchyDisplay

  • default: true
  • frontmatter: true

Disable dendron showing hierarchies on published pages

initializeRemoteVaults

  • default: true

Determines if dendron pulls in un-initialized remote vault at startup

  • default: true

If a note doesn't exist, don't create it via the GoToDefinition

If set, disable Cross Vault Links when using Copy Note Link and Insert Note Index.

randomNote

This setting is scheduled for deprecation ๐Ÿ“†

Use randomNote instead.

Configures the set of notes to include and exclude when using the Random Note command.

useContainers

  • default: false

Turn on to enable remark-container support

useFMTitle

When set to true, use frontmatter as title when publishing and in the preview.

useKatex

  • default: true

Turn on Katex support

If true, use the note title when displaying naked links. This also applies to note references.

  • NOTE: this is not yet fully supported for multi-vault. specifically, cross vault links are not yet supported

insertNoteIndex

This setting is scheduled for deprecation ๐Ÿ“†

Use insertNoteIndex instead.

Configures how Insert Note Index works.

marker

This setting is scheduled for deprecation ๐Ÿ“†

Use enableMarker instead.

  • default: false

If set to true, the inserted note index block will be wrapped between a marker like so:

<!-- Autogenerated Index Start -->
## Index
- [[Child|foo.child]]
<!-- Autogenerated Index End -->

usePrettyRefs

  • default: true

If set to false, don't use pretty refs

noRandomlyColoredTags

  • default: false

Do not display the automatically generated colors for tags in the editor. Only tag colors set by the user are used, other tags won't have colors and will look like regular links.

workspaceVaultSync

  • default: noCommit

See workspace sync configuration options for valid options.

Sets the synchronization strategy for workspace vaults. For regular vaults, please use the per-vault configuration.

autoFoldFrontmatter

  • default: true

When set to true, Dendron will automatically fold the frontmatter when opening new notes. This includes newly created notes, and existing notes that are being opened for the first time in this session of Visual Studio Code.

vaults

Tracks vaults for the workspace. You shouldn't have to manually edit this value. This is updated automatically when you first initialize a workspace and when you add or remove vaults to your workspace.

Vault properties:

See Vault Configuration

Journal

dailyDomain

  • type: string
  • default: daily

domain where daily journals are kept

dailyVault

  • type: string
  • default: none

Name of vault where daily journal should be in. If not set, default to current open vault.

name

  • type: string
  • default: journal

name used for journal notes

dateFormat

  • type: string
  • default: y.MM.dd

Date format used for journal notes. Use luxon style formatting

addBehavior

  • type: string
  • default: childOfDomain
  • options: ['childOfDomain', 'childOfDomainNamespace', 'childOfCurrent', 'asOwnDomain']

strategy for adding new journal notes

  • NOTE: this only applies to regular journal notes but not to daily journal notes.

Hooks

This configuration covers all hooks related sections

General Options

id

Unique id for the note. This also corresponds to the javascript file that will be created under {workspace}/hooks/{id}.js

pattern

  • default: *

A glob pattern that determines what notes the hook will be active for.

type

Type of script. Currently we support js scripts and might add additional options in the future.

Hook Types

onCreate

Runs when a note is created

Examples

hooks:
    onCreate:
        -
            id: hello
            pattern: '*'
            type: js

Graph

Graph configuration is nested under the graph object.

See example below

graph:
    zoomSpeed: 1 # The speed at which the graph zooms in and out. Lower is slower, higher is faster.

Dev

Development configuration covers option to enable experimental ๐Ÿงช features and when working on Dendron.

enableWebUI

  • default: false

Enables turning on Dendron's new web ui. Currently (2021.05.20), this means enabling the new Antd based tree view

Example

It will work by adding it under the dev section (which is not created in default).

dev:
    enableWebUI: true

Validation and AutoComplete

Dendron can provide validation when you edit the raw yaml using theConfigure (yaml) Command. In order to do so, you must have the redhat.vscode-yaml extension installed (this is a recommended extension for Dendron) The validator provides autocomplete, documentation & warnings when editing dendron.yml. Here's a few examples of what it looks like:

Hover over values to see documentation

Hover over values to see documentation

Autocomplete existing values

Autocomplete existing values

Validate existing values

Validate existing values

This setting is scheduled for deprecation ๐Ÿ“†

Use insertNoteLink instead.

Modifies behavior of the Insert Note Link command.

multiSelect

This setting is scheduled for deprecation ๐Ÿ“†

Use enableMultiSelect instead.

  • default: false

If set to true, enables multi-select for Insert Note Link Command.

aliasMode

This setting is scheduled for deprecation ๐Ÿ“†

Use aliasMode instead.

  • default: "none"
  • options: "snippet" | "selection" | "prompt" | "title" | "none"

Overrides default alias mode.

lookup

This setting is scheduled for deprecation ๐Ÿ“†

Use lookup instead.

Modifies behavior of lookup related commands Currently we only have settings for Note Lookup.

note

This setting is scheduled for deprecation ๐Ÿ“†

Use note instead.

Modifies behavior of Dendron: Lookup Note.

selectionType

This setting is scheduled for deprecation ๐Ÿ“†

Use selectionMode instead.

  • default: "selectionExtract"
  • options: "selectionExtract" | "selection2link" | "none"

Overrides default selection type modifier to be enabled with note lookup.

leaveTrace

This setting is scheduled for deprecation ๐Ÿ“†

Use leaveTrace instead.

  • type: boolean
  • default: none

With this set, it leaves a reference of the destination note in the source note while using selectionExtract.



Children

  1. Commands