silverbullet/website/SETTINGS.md

59 lines
1.9 KiB
Markdown
Raw Normal View History

2023-12-30 16:58:53 +08:00
This page contains settings for configuring SilverBullet and its Plugs. Changing any of these will go into effect immediately in most cases except `indexPage` and `customStyles`, which require a reload.
2022-10-12 17:47:13 +08:00
```yaml
# Initial page to load when launching SB, can contain template variables
indexPage: "[[SilverBullet]]"
2023-02-28 18:13:24 +08:00
2023-08-28 21:52:39 +08:00
# Load custom CSS styles from the following page, can also be an array
customStyles: "[[STYLES]]"
2023-07-02 20:48:27 +08:00
2024-01-25 18:42:36 +08:00
# Hide the sync button
hideSyncButton: false
# Configure the shown action buttons (top right bar)
actionButtons:
- icon: home # Use any icon from https://feathericons.com
2024-01-25 18:42:36 +08:00
command: "{[Navigate: Home]}"
description: "Go to the index page"
- icon: activity
2024-01-25 18:42:36 +08:00
description: "What's new"
command: '{[Navigate: To Page]("CHANGELOG")}'
- icon: message-circle
description: "Community"
command: '{[Navigate: To URL]("https://community.silverbullet.md")}'
- icon: book
2024-01-25 18:42:36 +08:00
command: "{[Navigate: Page Picker]}"
description: Open page
- icon: terminal
2024-01-25 18:42:36 +08:00
command: "{[Open Command Palette]}"
description: Run command
- icon: arrow-left
command: "{[Navigate: Back in History]}"
description: "Go to the previous page"
mobile: true # Only show on mobile devices, set to false to show only on desktop
2024-01-25 18:42:36 +08:00
# Override keyboard shortcuts and command priority
shortcuts:
2024-01-02 20:47:50 +08:00
- command: "{[Stats: Show]}" # Using the command link syntax here
mac: "Cmd-s" # Mac-specific keyboard shortcut
key: "Ctrl-s" # Windows/Linux specific keyboard shortcut
- command: "Navigate: Center Cursor" # But a command name is also supported
2024-01-02 20:47:50 +08:00
key: "Alt-x"
- command: "{[Upload: File]}"
priority: 1 # Make sure this appears at the top of the list in the command palette
2024-01-24 21:44:39 +08:00
- command: "{[Open Command Palette]}"
key: "Ctrl-."
2023-02-28 18:13:24 +08:00
2023-05-29 15:53:49 +08:00
# Defines files to ignore in a format compatible with .gitignore
spaceIgnore: |
dist
largefolder
*.mp4
2023-12-22 20:22:25 +08:00
# Add alternative names to emoji picker
emoji:
aliases:
smile: 😀
sweat_smile: 😅
2022-10-12 17:47:13 +08:00
```