Skip to content

Commit 27bd9d7

Browse files
committed
config: update obsidian-vault.example.yaml comments with white-label messaging
- Update header to focus on compatibility not replacement - Change 'drop-in replacement' to 'connect to' language - Update API key comment to be neutral about source - Improve grammar and clarity in periodic notes comment
1 parent b7f0ddd commit 27bd9d7

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

config/obsidian-vault.example.yaml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# markdown-vault Configuration as Drop-in Replacement for Obsidian Plugin
1+
# markdown-vault Configuration for Obsidian Vault Compatibility
22
#
3-
# Use this configuration to REPLACE the Obsidian Local REST API plugin
4-
# with markdown-vault pointing to your existing Obsidian vault.
3+
# Use this configuration to connect markdown-vault to your Obsidian vault
4+
# for API access to your notes and vault structure.
55
#
6-
# Key Benefits:
6+
# Key Features:
77
# - Works when Obsidian is closed
8-
# - More reliable than the plugin
8+
# - Dedicated API service for automation
99
# - Can run on servers/containers
1010
# - Obsidian does NOT need to be running
1111
#
12-
# Note: This reads Obsidian's configuration but operates independently
12+
# Note: Reads Obsidian's configuration but operates independently
1313

1414
server:
1515
host: "127.0.0.1"
@@ -32,8 +32,8 @@ vault:
3232
respect_gitignore: true
3333

3434
security:
35-
# Generate new API key for markdown-vault
36-
# (You can use the same key as Obsidian plugin had, but not required)
35+
# API key for authentication
36+
# (Can match existing API key from other services, or generate new)
3737
api_key: null
3838
cert_path: "./certs/server.crt"
3939
key_path: "./certs/server.key"
@@ -52,9 +52,9 @@ obsidian:
5252
respect_exclusions: true
5353

5454
periodic_notes:
55-
# When config_sync is enabled, these settings will be
56-
# imported from Obsidian's periodic notes plugin configuration
57-
# Manual settings here will be used as fallbacks
55+
# When config_sync is enabled, these settings are
56+
# imported from Obsidian's periodic notes plugin configuration.
57+
# Manual settings here are used as fallbacks.
5858

5959
daily:
6060
enabled: true

0 commit comments

Comments
 (0)