mingzailao
/
silverbullet
mirror of https://github.com/silverbulletmd/silverbullet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SETTINGS documentation

pull/380/head
Zef Hemel 2023-02-28 11:13:24 +01:00
parent ece4177e11
commit e2ed5cda0b
4 changed files with 29 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/SETTINGS.md
View File

@ -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
```

1
website/SilverBullet.md
View File

@ -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

4
website/Sync.md
View File

@ -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!
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.

3
website/🔌 Core/Templates.md
View File

@ -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