Guide: Getting started Coming From Dendron

Thorg aims to work smoothly for those coming from Dendron.

Thorg looks for the dendron.yml file to identify the workspace and performs its .thorg Data in Thorg Workspace ($THORG_WORKSPACE/.thorg) setup right next to it.

After installing Thorg, open your Dendron workspace and look for the Thorg activation message.

Callouts

Vault names come solely from the vault's folder name

Vault names are now derived solely from the vault's folder name and are no longer read from dendron.yml. (See Vault Name)

Most users won't be affected by this change, as vault names usually already match their corresponding folder names. However, if the name property in your dendron.yml configuration doesn't match your vault's folder name, an adjustment is needed for smooth operation with Thorg.

How to Adjust (Both Adjustments Are Needed):

Adjusting Your Vault's Name in dendron.yml

Open your dendron.yml file (found at the workspace level). You will see a vault configuration similar to this:

workspace:
    vaults:
        -
            fsPath: vault-2
            name: second-vault

To resolve the mismatch, you have two options:

  1. Rename the name property to explicitly match the fsPath (the vault's folder name).
  2. Delete the name property entirely.

Desired dendron.yml Configuration Examples:

workspace:
    vaults:
        -
            fsPath: vault-2
            name: vault-2

OR simply delete the name property:

workspace:
    vaults:
        -
            fsPath: vault-2
Adjusting Name in Your VS Code Workspace File (.code-workspace)

Your VS Code workspace file (e.g., dendron.code-workspace) might also contain name properties for your vaults under the folders array.

Locate your .code-workspace file (usually at the workspace root) and find entries similar to this:

{
    "folders": [
        {
            "path": "vault-2",
            "name": "second-vault"
        },
        // ... other folders
    ],
    // ... rest of the config
}

To achieve consistency, you have two options:

  1. Rename the name property to explicitly match the path (the folder name).
  2. Delete the name property entirely.

Desired .code-workspace Configuration Examples:

{
    "folders": [
        {
            "path": "vault-2",
            "name": "vault-2"
        },
        // ...
    ]
}

OR

{
    "folders": [
        {
            "path": "vault-2"
        },
        // ...
    ]
}


Children
  1. Dendron Compatibility Callouts