Workspace

Summary

This is the configuration namespace that holds all workspace related settings.

Below is an overview of what the workspace namespace looks like.

workspace:
  dendronVersion:
  workspaces:
  seeds:
  vaults:
  hooks:
  journal: 
    dailyDomain:
    dailyVault:
    name:
    dateFormat:
    addBehavior:
  scratch:
    name:
    dateFormat:
    addBehavior:
  task:
    statusSymbols:
    prioritySymbols:
    taskCompleteStatus:
  graph:
    zoomSpeed:
  disableTelemetry:
  enableAutoCreateOnDefinition:
  enableXVaultWikiLink:
  enableRemoteVaultInit:
  workspaceVaultSyncMode:
  enableAutoFoldFrontmatter:
  maxPreviewsCached:
  maxNoteLength:
  enableFullHierarchyNoteTitle:

dendronVersion

Dendron version. Set by the extension.

workspaces

Tracks workspaces.

seeds

Tracks seeds. See Seeds 🚧 (Private)

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. See Vault Configuration

hooks

Tracks information about hooks. See hooks

journal

Namespace for Journal related configurations.

dailyDomain

Sets the domain where the daily journals are kept

  • default: "daily"

dailyVault

Sets the name of the vault where daily journals are kept. If not set, defaults to current open vault.

  • default: none

name

Sets the name for journal notes

  • default: "journal"

dateFormat

Sets the date format to be used for journal notes. Use luxon style formatting

  • default: "y.MM.dd"

addBehavior

Sets the strategy for adding new journal notes. This only applies to regular journal notes but not to Daily Journal Notes. For possible options, see addBehavior options

  • default: "childOfDomain"

scratch

Namespace for Scratch note related configurations.

name

Sets the name for scratch notes

  • default: "scratch"

dateFormat

Sets the date format to be used for scratch notes. Use luxon style formatting

  • default: "y.MM.dd.HHmmss"

addBehavior

Sets the strategy for adding new scratch notes. For possible options, see addBehavior options

  • default: "asOwnDomain"

task

Configuration for tasks are under workspace.task namespace

workspace:
  task:
    ...

General

Task Display

Dendron uses this configuration to map the priority and status symbols used in the frontmatter to what gets displayed on the screen. By changing these configurations, you can change what gets displayed.

workspace:
    ...
    task:
        statusSymbols:
            "": " "
            "done": "x"
            ...
        prioritySymbols:
            H: "high"
            M: "medium"
            L: "low"
        taskCompleteStatus: ["x", "done"]

Extensions

graph

Namespace for graph related configurations. See Graph view

zoomSpeed

Determines the zoom speed in the graph view.

  • default: 1

disableTelemetry

Disables telemetry. See telemetry

enableAutoCreateOnDefinition

Sets the auto-create behavior when looking up definition.

  • default: false

Sets the x-vault wikilink behavior. See Cross Vault Links

  • default: false

enableRemoteVaultInit

Determines if Dendron should pull in un-initialized remote vaults at startup.

  • default: true

workspaceVaultSyncMode

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

  • default: "noCommit"
  • options: ["sync", "noCommit", "noPush", "skip"]

enableAutoFoldFrontmatter

Sets the frontmatter folding behaviour. 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 the current session of VS Code.

  • default: false

maxPreviewsCached

Sets the maximum number of rendered previews to be cached

  • default: 10

maxNoteLength

Maximum number of characters in a note. Notes with characters exceeding this number will have some Dendron features disabled.

  • default: 204800

enableEditorDecorations

Enables rich highlighting, decoration, and diagnostics when writing notes in Dendron. For example if disabled: wikilinks, hashtags, and user tags will not be highlighted, task note information will not be displayed, and Dendron will not warn for broken note frontmatter.

  • default: true

enableFullHierarchyNoteTitle

When enabled, the note title will utilize the full hierarchy to generate the title when a note is created. For example, if the note being created is one.two.three, the title will become One Two Three instead of Three. This command will not affect the title formatting of journal notes, which will still only keep the date portion as the title.

  • default: false

Backlinks