Link Search Menu Expand Document

Dendrons Config

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

End anchor * not found

General

defaultInsertHierarchy

Execute Insert Note with a hierarchy in place

generateChangelog

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

Turn on to enable changelogs

hierarchyDisplayTitle

  • default: Children

Controls the title for children links in published sites

lookupConfirmVaultOnCreate

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.

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.

randomNote

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

usePrettyRefs

  • default: true

If set to false, don't use pretty refs

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.

defaultDailyJournalVault

Execute Create Daily Journal Note with a default vault in place

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

dailyVault

  • type: string
  • default: none

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

dailyVault

domain where daily journals are kept

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

Dev

Development configuration covers option to enable [[experimental ๐Ÿงช|dendron.ref.status#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