Configuration

Summary

All vault related settings

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.

workspace

• required: false

If set, specifies the workspace that this vault belongs

remote

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

sync

• default: sync

See workspace sync configuration options for valid options.

Sets the synchronization strategy for this vault. This overrides the workspace vault sync option if it is set.

Publishing Properties

• siteUrl
• siteIndex

Example:

workspace:
  vaults: 
        -
            fsPath: vault2
            siteUrl: "https://dendron.so"    

Configuration Examples

Local Vault

vaults:
  - fsPath: vault

This will have the following file layout

.
└── workspace
    └── vault

Remote Vault

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

This will have the following file layout

.
└── workspace
    |── dendron-vault
    └── yc-vault

Remote Workspace Vault

vaults:
  - fsPath: handbook
    workspace: handbook-workspace
    name: handbook
workspaces:
  handbook-workspace:
    remote:
      type: git
      url: "git@github.com:dendronhq/handbook.git"

This will have the following file layout

.
└── workspace
    └── handbook-workspace
        └── handbook-vault

---

Backlinks

• Changelog
• Seeding Digital Gardens and Connecting Second Brains
• Configuration
• Transitive Vaults