Skip to content

Github

These settings an be accessed via the Gistr Plugin Settings.

  • Open Obsidian Settings ⚙️ interface
  • Select Community Plugins in left menu
  • Locate Gistr plugin, and click Settings ⚙️ icon
  • Click the Save & Sync tab


Gistr > Settings > Github
Gistr > Settings > Save & Sync



Enable Ribbon Icons

1.4.0 true

Adds the following buttons to your Obsidian ribbon on the left-side of the interface:

  • Save Public Gist
  • Save Private Gist
Enable save icons
Enable save icons


Enabled

Two new buttons will be displayed on the left-side Ribbon of Obsidian which allow you to save public and private gists.

Disabled

You will need to open the Obsidian Command Palette if you wish to save public or private gists from your notes.


Allow Updating Gists

1.4.0 true

This setting allows you to update gists that you have created from your notes.


Enabled

You will be able to make changes to any gists you have created from your notes by using the Save Gist command or button.

Disabled

You will only be able to create gists from your notes, once the note has been uploaded as a gist, you will not have the option to update the gist later if you need to make changes.


Enable Autosave

1.4.0 false

When this setting is enabled; Gistr will keep monitoring your activity when you are editing a note that you have previously uploaded as a gist. When you stop typing in your note, the system will start the clock on how long it has been since your last edit. Once a certain duration is reached; Gistr will push your changes from your Obsidian note and upload those so that your gist reflects the same changes.


Enabled

Any notes you have previously uploaded as a gist will be constantly monitored for changes and those changes will be pushed to your gist automatically.

Disabled

You will need to manually save changes you have made to your gists by using either the Save Buttons which can be enabled with the setting Enable Ribbon Icons, or by opening your Obsidian command palette.


Enable Autosave Strict Saving

1.4.0 false

This setting determines how autosave will behave. Autosave duration can be modified further down in these settings.


Enabled

Your notes will be saved to the gist service precisely on time every 15 seconds, whether you are still typing or not.

Disabled

Time until save will not start until you have finished typing in that note. If you continue typing, the saving countdown will not start until your final key is pressed.


Enable Autosave Notices

1.4.0 true

Each time your note is saved automatically, a notice will appear on-screen informing you of the action. This only works if Enable Autosave is turned on.


Enabled

You will receive a notice on every autosave triggered.

Disabled

Autosave will complete silently.


Autosave Duration

1.4.0 120

How often autosave will execute in seconds. Set this to a fair amount so that the calls aren\'t being ran excessively to the gist API server (Github or OpenGist).

The save countdown timer will begin shortly after you stop typing.

If you wish to change this to save precisely every X seconds, enable the setting Autosave Strict Saving located above.

You may also change the Autosave duration.


Include Frontmatter

1.4.0 false

When saving your note as a new gist, frontmatter will be included in the upload when the gist is saved to the online service.

No matter if this setting is enabled or not, frontmatter will be at the top of your actual note. However, this setting determines if that frontmatter is carried over to your uploaded gist.

Frontmatter begins with --- at the top of your note, with the following structure:

---
gists:
  - file: Your Note.md
    is_public: false
    id: 567cae123abc456def012abc456def12
    url: 'https://gist.github.com/Aetherinox/567cae123abc456def012abc456def12'
    user: Aetherinox
    revisions: 1
    created_at: '2024-03-31T06:33:38Z'
    updated_at: '2024-03-31T06:33:38Z'
---


Enabled

Frontmatter added to your notes will be included when your note is pushed to a gist service.

Disabled

The note will be cleaned before it is pushed to the gist service and no frontmatter fields will be present in the online version.


Save List: Show All

1.4.0 false

This setting effects how the gist save list displays saved gists. By default, if you have the same note saved as both a public and a secret gist; the save list will only show the saved gist depending on the button you have pressed.

Ribbon save buttons
Ribbon save buttons

This means that if you press Save Public, only the public gist will appear in the list, and the same goes for secret gists. However, if this is enabled, both public and secret saves will show in the same list.

Gist Save List
Gist Save List


Enabled

When saving an existing gist, the suggestion box will display ALL saves for that note in the same list; both public and secret.

Disabled

Public and secret gist saves will be separated when being displayed in the existing gist save list.


Save List: Datetime Format

1.4.6 MM.DD.YYYY h:m:s a

This setting affects the gist save list and allows you to customize how the date and time will appear next to each gist in your save list which indicates when you saved last.

Date and Time Formats
Type Flag Output
Month M 1 2 ... 11 12
Mo 1st 2nd ... 11th 12th
MM 01 02 ... 11 12
MMM Jan Feb ... Nov Dec
MMMM January February ... November December
Quarter Q 1 2 3 4
Qo 1st 2nd 3rd 4th
Day of Month D 1 2 ... 30 31
Do 1st 2nd ... 30th 31st
DD 01 02 ... 30 31
Day of Year DDD 1 2 ... 364 365
DDDo 1st 2nd ... 364th 365th
DDDD 001 002 ... 364 365
Day of Week d 0 1 ... 5 6
do 0th 1st ... 5th 6th
dd Su Mo ... Fr Sa
ddd Sun Mon ... Fri Sat
dddd Sunday Monday ... Friday Saturday
Day of Week (Locale) e 0 1 ... 5 6
Day of Week (ISO) E 1 2 ... 6 7
Week of Year w 1 2 ... 52 53
wo 1st 2nd ... 52nd 53rd
ww 01 02 ... 52 53
Week of Year (ISO) W 1 2 ... 52 53
Wo 1st 2nd ... 52nd 53rd
WW 01 02 ... 52 53
Year YY 70 71 ... 29 30
YYYY 1970 1971 ... 2029 2030
YYYYYY -001970 -001971 ... +001907 +001971
Note: Expanded Years (Covering the full time value range of approximately 273,790 years forward or backward from 01 January, 1970)
Y 1970 1971 ... 9999 +10000 +10001
Note: This complies with the ISO 8601 standard for dates past the year 9999
Era Year y 1 2 ... 2020 ...
Era N, NN, NNN BC AD
NNNN Before Christ, Anno Domini
NNNNN BC AD
Week Year gg 70 71 ... 29 30
gggg 1970 1971 ... 2029 2030
Week Year (ISO) GG 70 71 ... 29 30
GGGG 1970 1971 ... 2029 2030
AM/PM A AM PM
a am pm
Hour H 0 1 ... 22 23
HH 00 01 ... 22 23
h 1 2 ... 11 12
hh 01 02 ... 11 12
k 1 2 ... 23 24
kk 01 02 ... 23 24
Minute m 0 1 ... 58 59
mm 00 01 ... 58 59
Second s 0 1 ... 58 59
ss 00 01 ... 58 59
Fractional Second S 0 1 ... 8 9
SS 00 01 ... 98 99
SSS 000 001 ... 998 999
SSSS ...
SSSSSSSSS		 000[0..] 001[0..] ... 998[0..] 999[0..]
Time Zone z or zz EST CST ... MST PST
Z -07:00 -06:00 ... +06:00 +07:00
ZZ -0700 -0600 ... +0600 +0700
Unix Timestamp X 1360013296
Unix Millisecond Timestamp x 1360013296123


Save List: Icon Color

1.4.6 #757575E6   

Color for icon in gist save list

Save List Icon Color
Save List Icon Color