fix: improve TOML error handing and docs for Windows paths (#31)

* fix: improve TOML error handing and documentation for Windows paths

* build(linting): pash ruff v2.0.260
This commit is contained in:
Nathaniel Landau
2023-03-30 10:33:51 -04:00
committed by GitHub
parent 5a4643ea8f
commit 4df10e785e
8 changed files with 42 additions and 29 deletions

View File

@@ -122,6 +122,8 @@ Below is an example with two vaults.
["Vault One"] # Name of the vault.
# Path to your obsidian vault
# Note for Windows users: Windows paths must use `\\` as the path separator due to a limitation with how TOML parses strings.
# Example: "C:\\Users\\username\\Documents\\Obsidian"
path = "/path/to/vault"
# Folders within the vault to ignore when indexing metadata
@@ -141,6 +143,10 @@ Below is an example with two vaults.
To bypass the configuration file and specify a vault to use at runtime use the `--vault-path` option.
**Note for Windows users:**
Due to how TOMML parses strings, Windows paths must use `\\` as the path separator.
For example: `C:\\Users\\username\\Documents\\Obsidian`
### Make Bulk Updates
Bulk edits are supported by importing a CSV file containing the following columns. Column headers must be lowercase.