Configuration

Summary

dendron.yml located at the root of your workspace.

It can be modified using the Configure (yaml) command.

All commands are grouped by scope except those mentioned underneath Legacy Configuration

Scopes

Validation and AutoComplete

Dendron can provide validation when you edit the raw yaml using theConfigure (yaml) Command (Private). 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

Legacy Configuration

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 section will gradually be marked as "deprecated" as we move them to a better place.

defaultInsertHierarchy

This setting is scheduled for deprecation ๐Ÿ“†

Use initialValue instead.

Execute Insert Note (Private) 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

This setting is scheduled for deprecation ๐Ÿ“†

Use bubbleUpCreateNew (Private) instead.

  • 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: true

Turn on to enable mermaid support for publishing.

noCaching

Disable dendron caching

noTelemetry

This setting is scheduled for deprecation ๐Ÿ“†

Use disableTelemetry instead.

Disable telemetry

hierarchyDisplay

  • default: true
  • frontmatter: true

Disable dendron showing hierarchies on published pages

initializeRemoteVaults

This setting is scheduled for deprecation ๐Ÿ“†

Use enableRemoteVaultInit instead.

  • default: true

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

noAutoCreateOnDefinition

This setting is scheduled for deprecation ๐Ÿ“†

Use enableAutoCreateOnDefinition instead.

  • default: true

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

This setting is scheduled for deprecation ๐Ÿ“†

Use enableXVaultWikiLink instead.

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

randomNote

This setting is scheduled for deprecation ๐Ÿ“†

Use randomNote instead.

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

useContainers

  • default: false

Turn on to enable remark-container support

useFMTitle

When set to true, use frontmatter as title when publishing.

useKatex

  • default: true

Turn on Katex support for publishing.

enableUserTags

  • default: true

Enables user tags support.

enableHashTags

  • default: true

Enables hashtags support.

If true, use the note title when displaying naked links when published. 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 (Private) 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 when publishing.

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

This setting is scheduled for deprecation ๐Ÿ“†

Use workspaceVaultSyncMode instead.

  • 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

This setting is scheduled for deprecation ๐Ÿ“†

Use enableAutoFoldFrontmatter instead.

  • 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

This setting is scheduled for deprecation ๐Ÿ“†

Use vaults instead.

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

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


Children

  1. Commands
  2. Preview
  3. VSCode Config
  4. Workspace