diff --git a/website/SETTINGS.md b/website/SETTINGS.md index bb24e6ba..b4015281 100644 --- a/website/SETTINGS.md +++ b/website/SETTINGS.md @@ -1,6 +1,28 @@ -This page contains settings for configuring SilverBullet and its Plugs. Any -changes outside of the yaml block will be overwritten. +This page contains settings for configuring SilverBullet and its Plugs. Changing any of these in most cases will go into effect immediately, except for `indexPage` which requires a reload. ```yaml +# Initial page to load when launching SB indexPage: SilverBullet + +# Template related settings +pageTemplatePrefix: "template/page/" +snippetPrefix: "snippet/" + +quickNotePrefix: "📥 " + +dailyNotePrefix: "📅 " +dailyNoteTemplate: "template/page/Daily Note" + +weeklyNotePrefix: "🗓️ " +weeklyNoteTemplate: "template/page/Weekly Note" +weeklyNoteMonday: false + +# Markdown +previewOnRHS: true + +# Sync +sync: + # Do not sync pages with a specific prefix + excludePrefixes: + - PLUGS ``` diff --git a/website/SilverBullet.md b/website/SilverBullet.md index 1b8fafde..6bc917c3 100644 --- a/website/SilverBullet.md +++ b/website/SilverBullet.md @@ -96,6 +96,7 @@ Click on the links below to explore various aspects of SilverBullet more in-dept * [[CHANGELOG]]: What’s new? * [[🔌 Plugs]]: extensions available for, and as part of SilverBullet +* [[SETTINGS]]: What settings exist and how to change them * [[Special Pages]]: a few page names in Silver Bullet have special meaning * [[🔨 Development]]: how to start hacking on SilverBullet itself diff --git a/website/Sync.md b/website/Sync.md index 2d46b3e9..f61726a4 100644 --- a/website/Sync.md +++ b/website/Sync.md @@ -41,4 +41,6 @@ Sync is triggered: * This is new code, and not been extremely thoroughly tested. Make backups. * The sync engine doesn’t synchronize `_plugs` code, so to update the plug list based on your [[PLUGS]] you have to manually run {[Plugs: Update]}. -So, if you’re ready for this. Go try it. We do recommend: make regular backups in case the proverbial shit hits the fan, don’t say we didn’t warn you! \ No newline at end of file +So, if you’re ready for this. Go try it. We do recommend: make regular backups in case the proverbial shit hits the fan, don’t say we didn’t warn you! + +You can tweaks some things in sync, such as excluding certain prefix from sync. For this, see the [[SETTINGS]] documentation. \ No newline at end of file diff --git a/website/🔌 Core/Templates.md b/website/🔌 Core/Templates.md index 615a3801..04a129c1 100644 --- a/website/🔌 Core/Templates.md +++ b/website/🔌 Core/Templates.md @@ -53,8 +53,7 @@ Which would insert the cursor right after `#query`. ### Daily Note -The {[Open Daily Note]} command navigates (or creates) a daily note prefixed -with a 📅 emoji by default, but this is configurable via the `dailyNotePrefix` setting in `SETTINGS`. If you have a page template (see above) named `template/page/Daily Note` it will use this as a template, otherwise, the page will just be empty (this path is also configurable via the `dailyNoteTemplate` setting). +The {[Open Daily Note]} command navigates (or creates) a daily note prefixed with a 📅 emoji by default, but this is configurable via the `dailyNotePrefix` setting in `SETTINGS`. If you have a page template (see above) named `template/page/Daily Note` it will use this as a template, otherwise, the page will just be empty (this path is also configurable via the `dailyNoteTemplate` setting). ### Weekly Note