Global Settings¶
These are generic settings that do not belong to a specific category.
| Setting | Description |
|---|---|
| Theme | The theme that will be used to display gists embedded in your notes. If you force a single gist snippet to use a particular theme, this will be overwritten for that one gist only. |
| Text Wrapping | This will determine if gists display a horizontal scrollbar. If a gist contains text that is not wrapped, a scrollbar will appear and allow you to scroll over the width of the gist. Enabled = text will be wrapped to the next line. Disabled = codeblock will display horizontal scrollbar |
| Trigger Keyword | This is the phrase to use when initializing a new gist codeblock. If you change this value, you must go through your notes and also change to the new keyword. |
| Enable update notifications | This will determine if you receive a notification box when you first launch Obsidian if Gistr has a new update available. This includes both stable and beta versions. |
| Notification duration | If Gistr sends you a notification, this will determine how long you see the notification for. Set to 0 if you wish for notifications to stay open and not disappear until you click on them. |
| Enable refresh icon | Adds a special icon to the top header ribbon of your Obsidian interface which forcefully refreshes all of your embedded gist codeblocks, making color changes appear immediately. |
Theme¶
1.0.0
light
This setting allows you to switch the color which is used for codeblocks that are turned into gists.
Gistr comes with two themes:
- Light Mode
- Dark Mode
The Themes setting allows you to flip between these two themes for your gist codeblocks; no matter what theme you use for Obsidian.
On top of being able to select which theme that gists are displayed in; you will also be able to override this setting for any specific gist. These settings however, are covered in the sections:
Text Wrapping¶
1.3.0
false
This feature will determine how text from your gist snippets appears in Obsidian codeblocks.
-
Enabled -
No matter what the structure of the text in the gist is; Gistr will attempt to word-wrap lines that exceed the width of the gist codeblock.
-
Disabled -
Gist codeblocks will try to make text appear just as it does in your original gist. If you embed a paste which has text only on one line; Gistr will attempt to display your gist in the same exact manner.
Trigger Keyword¶
1.0.0
gistr
This is the phrase to use when initializing a new gist codeblock. If you change this value, you must go through your notes and also change to the new keyword.
The keyword is what begins your codeblock for embedding gists:
By default, the keyword is gistr
Enable Update Notifications¶
1.4.6
true
This will determine if you receive a notification box when you first launch Obsidian if Gistr has a new update available. This includes both stable and beta versions.
-
Enabled -
When launching Obsidian; you will receive a system notification indicating an update is available for Gistr. This feature uses your operating system notification functionality. This includes both stable and beta releases.
-
Disabled -
No notification will display when updates are available. You must manually check.
Notification Duration¶
1.4.0
10 seconds
If Gistr sends you a notification, this will determine how long you see the notification for.
Set to 0 if you wish for notifications to stay open and not disappear until you click on them.
This setting is for ALL notifications, not just update notifications.
Enable Refresh Icon¶
1.6.1
false
Adds a special icon to the top header ribbon of your Obsidian interface. This button will force your embedded gistr codeblocks to automatically refresh once pressed. By default, Gistr caches any codeblocks you have added to ensure that content from Github and Opengist appears immediately. This means that when you change settings such as colors; the change will not appear immediately. By using this button, changes will immediately take affect and be visible in your notes.