Skip to content

Commit 92b14cc

Browse files
committed
Updated gist id in docs
1 parent 6e68612 commit 92b14cc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -142,23 +142,23 @@ See other `peerDependencies` you may need in the package.json in the root of thi
142142
1. Provide your gist id into the input `gistId`, or
143143
2. Provide a direct `NgxGist` mobdel in the input `gist`.
144144

145-
Note: For example your gist id would be `TH1515TH31DT0C0PY` in:
145+
Note: For example your gist id would be `TH1515TH3G15T1D` in:
146146

147-
https://gist.github.com/YourUserName/TH1515TH31DT0C0PY
147+
https://gist.github.com/YourUserName/TH1515TH3G15T1D
148148

149149
### Default - fetched gist (auto cached for 24 hours)
150150

151151
ngx-gist will fetch the gist once and store it locally for 24 hours. In that timeframe, if the user returns or visits another page where this gist was previously loaded, it will reload the content without having to reach out to GitHub again.
152152
```html
153-
<ngx-gist gistId="gistId_123abc"></ngx-gist>
153+
<ngx-gist gistId="TH1515TH3G15T1D"></ngx-gist>
154154
```
155155

156156
### Fetched gist (forced no cache)
157157

158158
Force no cache. This will force ngx-gist to retrieve the content live from GitHub every time this content loads. This is disabled by default, but could be useful if your gists change frequently.
159159
```html
160160
<ngx-gist
161-
gistId="gistId_123abc"
161+
gistId="TH1515TH3G15T1D"
162162
[useCache]="false"
163163
></ngx-gist>
164164
```
@@ -169,7 +169,7 @@ Select a "highlight.js" code theme to apply. Note: Only one theme can be loaded
169169
```html
170170
<ngx-gist
171171
codeTheme="github"
172-
gistId="gistId_123abc"
172+
gistId="TH1515TH3G15T1D"
173173
></ngx-gist>
174174
```
175175

@@ -179,7 +179,7 @@ Display only one specific file when your gist has many.
179179
```html
180180
<ngx-gist
181181
displayOnlyFileNames="super.js"
182-
gistId="gistId_123abc"
182+
gistId="TH1515TH3G15T1D"
183183
></ngx-gist>
184184
```
185185

@@ -189,7 +189,7 @@ You can also display any number of specific files by name.
189189
```html
190190
<ngx-gist
191191
[displayOnlyFileNames]="['csstest.css', 'main.ts']"
192-
gistId="gistId_123abc"
192+
gistId="TH1515TH3G15T1D"
193193
></ngx-gist>
194194
```
195195

@@ -205,7 +205,7 @@ These are not fetched from GitHub and are brought in elsewhere from your applica
205205
Line numbers are enabled by default, but you can turn them off like so.
206206
```html
207207
<ngx-gist
208-
gistId="d55ea012b585a16a9970878d90106d74"
208+
gistId="TH1515TH3G15T1D"
209209
[showLineNumbers]="false"
210210
></ngx-gist>
211211
```
@@ -219,7 +219,7 @@ Line numbers are enabled by default, but you can turn them off like so.
219219
| **codeTheme** | `HighlightJsTheme` (string) | `'default'` | The `highlight.js` code theme to use and display. Note: Only _one_ theme can be loaded on a single page at a time! The first theme to load will apply to all gists on the page. |
220220
| **displayOnlyFileNames** | `string \| string[] \| undefined` | `undefined` | Display in the DOM only the selected filename(s) from the gists files array. Can be either a string or string array. File names much match exactly, be sure to remove any leading or trailing whitespace in the provided strings. |
221221
| **gist** | `NgxGist \| undefined` | `undefined` | Provide a static gist model here directly which will be displayed if no `gistId` is provided for remote fetching. Also this model will be displayed should a fetch fail when retrieving `gistId`, or overwritten once the pertaining `gistId` data is fetched. |
222-
| **gistId** | `string` | `undefined` | Provide the GitHub gist id to be fetched and loaded. This can be found in URL of the gists you create. For example the id `TH1515TH31DT0C0PY` in: https://gist.github.com/YourUserName/TH1515TH31DT0C0PY. Alternatively, provide a value directly in the sibling input `gist`. |
222+
| **gistId** | `string` | `undefined` | Provide the GitHub gist id to be fetched and loaded. This can be found in URL of the gists you create. For example the id `TH1515TH3G15T1D` in: https://gist.github.com/YourUserName/TH1515TH3G15T1D. Alternatively, provide a value directly in the sibling input `gist`. |
223223
| **hideGistLink** | `bool` | `false` | Optionally hide the gist link which opens the gist on GitHub. The gist links automatically display for remote gists, but can be hidden with this feature. |
224224
| **materialTheme** | `MaterialPrebuiltTheme \| undefined` | `undefined` | Define a material core theme to apply. Ideally, you should already have your global material theme set at the root of your project so try to avoid using this if possible. Note: These are loaded from the CDN: `https://unpkg.com` |
225225
| **showLineNumbers** | `bool` | `true` | Display or hide the line numbers in your gist code snippets. |

0 commit comments

Comments
 (0)