Skip to content

Commit 22015a4

Browse files
committed
docs: update readme
1 parent f3df922 commit 22015a4

File tree

1 file changed

+13
-28
lines changed

1 file changed

+13
-28
lines changed

README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ This option displays gists in a codeblock with line numbers, and the text of the
106106
<br /><br />
107107

108108
### 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.
110110

111111
<br />
112112

@@ -116,23 +116,25 @@ This option displays gists in a browser-like environment. This method allows you
116116
<br />
117117

118118
## 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.
120120

121121
<br />
122122

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`.
124124

125125
<br />
126126

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).
128128

129129
<br />
130130

131131
<p align="center"><img style="width: 85%;text-align: center;border: 1px solid #353535;" src="https://github.com/Aetherinox/obsidian-gistr/assets/118329232/d787bb1c-1179-4293-bf67-d2bc3dbf0e5b"></p>
132132

133133
<br />
134134

135-
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.
136138
137139
<br />
138140

@@ -141,7 +143,7 @@ To convert your notes into gists, you must register for a [Personal Access Token
141143
<br />
142144

143145
# 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:
145147

146148
<br />
147149

@@ -155,15 +157,12 @@ url: https://gist.github.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
155157

156158
<br />
157159

158-
This plugin can also fetch a Gist which contains multiple notes in a single gist collection:
159-
160-
<br />
161-
162160
<p align="center"><img style="width: 85%;text-align: center;border: 1px solid #353535;" src="https://github.com/Aetherinox/obsidian-gistr/assets/118329232/062f2dc0-c14a-4d4f-a3e0-5358458a528a"></p>
163161

164162
<br />
165163

166-
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:
167166

168167
````shell
169168
```gistr
@@ -178,15 +177,7 @@ If you do not target a specific file on a gist which contains multiple files, al
178177

179178
<br />
180179

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`:
190181

191182
````shell
192183
```gistr
@@ -216,13 +207,7 @@ url: https://gist.yourdomain.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
216207

217208
<br />
218209

219-
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`:
226211

227212
<br />
228213

@@ -375,4 +360,4 @@ You will be presented with JSON which defines the values associated to your crea
375360

376361
# Shoutouts
377362
- [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

Comments
 (0)