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 can pick the vault for new notes.

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

noAutoCreateOnDefinition

  • 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.

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

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:

fsPath

  • file path to vault

name

  • default: last component of fsPath

vault name

visibility

  • choices: "private|public"

If set to private, notes in this vault will not be published regardless of any other configuration. This takes precedences over everything.

remote

  • added property for remote vaults
  • properties
    • type: currently only git is supported (in the future, we might add additional types)
    • url: url to github repo

Local Vault Example

vaults:
    - fsPath: vault

Remote Vault Example

vaults:
    -
        fsPath: dendron-vault
        remote:
            type: git
            url: 'git@github.com:kevinslin/dendron-vault.git'
        name: dendron
    -
        fsPath: yc-vault
        remote:
            type: git
            url: 'git@github.com:kevinslin/yc-vault.git'
        name: yc

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