You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-28Lines changed: 13 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -106,7 +106,7 @@ This option displays gists in a codeblock with line numbers, and the text of the
106
106
<br /><br />
107
107
108
108
### Method 2: Integrated Browser
109
-
This option displays gists in a browser-like environment. This method allows you to sign into Github and view, or edit your gists.
109
+
This option displays gists in a browser-like environment. It allows you to sign into Github or your Opengist site and view / edit your gists.
110
110
111
111
<br />
112
112
@@ -116,23 +116,25 @@ This option displays gists in a browser-like environment. This method allows you
116
116
<br />
117
117
118
118
## Convert Note to Gist:
119
-
This feature allows you to take notes currently in Obsidian and convert them over to gists which will be hosted on services like Github.
119
+
This feature allows you to take notes in your Obsidian vault and upload them as gists to Github or Opengist.
120
120
121
121
<br />
122
122
123
-
After writing your note in Obsidian, right-click anywhere in your note and select **Save Gist** as either a public or secret note.
123
+
After writing your note in Obsidian, right-click anywhere in your note and select **Save Gist**, then choose the type: `public` or `secret`.
124
124
125
125
<br />
126
126
127
-
If you have a note as an existing gist saved, Gistr will confirm you wanting to save your gist by listing it in the suggestion box. Click the note name to push your changes.
127
+
If you have already uploaded an Obsidian note as a gist, you can update the gist right from Obsidian. Either manually save, or allow the plugint o automatically update your gist every x minutes (can be changed in the plugin settings).
To convert your notes into gists, you must register for a [Personal Access Token](https://github.com/settings/tokens?type=beta) on Github.
135
+
> [!NOTE]
136
+
>
137
+
> To convert your notes into gists, you must register for a [Personal Access Token](https://github.com/settings/tokens?type=beta) on Github.
136
138
137
139
<br />
138
140
@@ -141,7 +143,7 @@ To convert your notes into gists, you must register for a [Personal Access Token
141
143
<br />
142
144
143
145
# Usage
144
-
To embed a Github Gist snippet or OpenGist, add a new code block:
146
+
To embed a snippet from Github or OpenGist, add a new code block:
If your gist contains multiple files, you may target a specific note inside a gist, append `#filename` to the end of your gist url:
164
+
This plugin can also fetch a Gist which contains multiple notes in a single collection. If your gist contains multiple files, you can target a specific note to show by using the `file`
165
+
property:
167
166
168
167
````shell
169
168
```gistr
@@ -178,15 +177,7 @@ If you do not target a specific file on a gist which contains multiple files, al
178
177
179
178
<br />
180
179
181
-
Despite whatever theme you have selected in the Gistr settings, you can force a gist note to use a specific theme by appending `&themename` to the end of the url
182
-
183
-
<br />
184
-
185
-
**Theme Options:**
186
-
-`dark`
187
-
-`light`
188
-
189
-
<br />
180
+
You can force an individual gist to use a specific theme. You may choose the theme `dark` or `light`:
You may also force an individual gist to use a specific theme:
220
-
221
-
<br />
222
-
223
-
**Theme Options:**
224
-
-`dark`
225
-
-`light`
210
+
You can force an individual gist to use a specific theme. You may choose the theme `dark` or `light`:
226
211
227
212
<br />
228
213
@@ -375,4 +360,4 @@ You will be presented with JSON which defines the values associated to your crea
375
360
376
361
# Shoutouts
377
362
-[thomiceli](https://github.com/thomiceli) over at [OpenGist](https://github.com/thomiceli/opengist) for implementing the JSON functionality request.
378
-
-[linjunpop](https://github.com/linjunpop) for developing the first Obsidian [Gist](https://github.com/linjunpop/obsidian-gist) plugin. It was a top choice in my list of plugins used.
363
+
-[linjunpop](https://github.com/linjunpop) for developing the first Obsidian [Gist](https://github.com/linjunpop/obsidian-gist) plugin. It was a top choice in my list of plugins used.
0 commit comments