Skip to content

Commit a352e34

Browse files
committed
Doc and example updates
1 parent 6599e18 commit a352e34

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
[![Node Version](https://badgen.net/npm/node/@proangular/ngx-gist)](https://www.npmjs.com/@proangular/ngx-gist)
1717
[![Package Downloads](https://badgen.net/npm/dw/@proangular/ngx-gist)](https://www.npmjs.com/@proangular/ngx-gist)
1818
[![Size](https://img.shields.io/bundlephobia/minzip/@proangular/ngx-gist.svg)](https://bundlephobia.com/result?p=ProAngular/ngx-gist)
19+
[![Demo Status](https://badgen.net/badge/Demo/Online/green)](https://www.ProAngular.com/demos/ngx-gist)
1920
[![Website Status](https://img.shields.io/website?down_color=lightgrey&down_message=Offline&label=Website&up_color=green&up_message=Online&url=https%3A%2F%2Fwww.proangular.com)](https://www.proangular.com)
2021
[![Gitter Chat](https://badges.gitter.im/ProAngular/lobby.svg)](https://gitter.im/ProAngular/community)
2122
[![Discord Chat](https://img.shields.io/discord/1003103094588055552?label=Discord)](https://discord.com/channels/1003103094588055552)
@@ -24,11 +25,6 @@
2425
[![GitHub Package Status](https://github.com/ProAngular/ngx-gist/actions/workflows/on-merge-main-deploy-gpr.yml/badge.svg)](https://github.com/ProAngular/ngx-gist/actions/workflows/on-merge-main-deploy-gpr.yml)
2526
[![npmjs Package Status](https://github.com/ProAngular/ngx-gist/actions/workflows/on-merge-main-deploy-npmjs.yml/badge.svg)](https://github.com/ProAngular/ngx-gist/actions/workflows/on-merge-main-deploy-npmjs.yml)
2627

27-
<!--
28-
[![StackBlitz](https://badgen.net/badge/StackBlitz/Offline/red)]()
29-
[![Demo](https://badgen.net/badge/Demo/Offline/red)]()
30-
-->
31-
3228
## Table of Contents
3329

3430
- [Information](#information)
@@ -58,7 +54,7 @@ More info in the following links:
5854

5955
## Description
6056

61-
Behold, this package contains an Angular Material and HighlighJs styled element which displays your GitHub gists in a conveniant, easy to view interface. Don't have a gist? No problem, display your own code snippets by just passing in the same model! All files from the remote/local gist are displayed in separate tabs for users to easily navigate. Many optional features and themes are available.
57+
Behold, this package contains an Angular Material and HighlighJs styled element which displays your GitHub gists in a conveniant, easy to view interface. Don't have a gist? No problem, display your own code snippets by just passing in a direct model (`NgxGist.create({ ... })`)! All files from the remote/local gist are displayed in separate tabs for users to easily navigate. Many optional features and themes are available.
6258

6359
GitHub gists can be created here: https://gist.github.com/
6460

@@ -72,6 +68,8 @@ Enjoy!
7268
<img src="src/assets/images/demo-gist.gif" />
7369
</p>
7470

71+
Live demo here: [https://www.ProAngular.com/demos/ngx-gist](https://www.ProAngular.com/demos/ngx-gist)
72+
7573
<a name="installation"/>
7674

7775
## Installation
@@ -213,7 +211,7 @@ You can also display any number of specific files by name.
213211

214212
### Displaying a basic code snippet (without a remote gist)
215213

216-
These are not fetched from GitHub and are brought in elsewhere from your application (seperate HTTP request, or statically for example). With this method you can display code snippets without having to create a remote gist. Also, please notice here that no "Open Gist on GitHub" link will display as well.
214+
These are not fetched from GitHub and are brought in elsewhere from your application (seperate HTTP request, or statically for example). With this method you can display code snippets without having to create a remote gist. You can easily create a new code snippet/gist object using `NgxGist.create({ ... })`. Note: no "Open Gist on GitHub" link will display.
217215
```html
218216
<ngx-gist [gist]="localGistObject"></ngx-gist>
219217
```

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@proangular/ngx-gist",
3-
"version": "1.0.7",
3+
"version": "1.0.8",
44
"description": "An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.",
55
"author": "Pro Angular <webmaster@proangular.com>",
66
"homepage": "https://www.proangular.com",

src/app/app.component.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,11 @@ import { Component } from '@angular/core';
6565
<h4>DISPLAYING A BASIC CODE SNIPPET (WITHOUT A REMOTE GIST)</h4>
6666
<p>
6767
These are not fetched from GitHub and are brought in elsewhere from your
68-
application (separate HTTP request, or statically, for example). With
69-
this method, you can display code snippets without having to create a
70-
remote gist. Also, please notice here that no "Open Gist on GitHub" link
71-
is displayed here.
68+
application (seperate HTTP request, or statically for example). With
69+
this method you can display code snippets without having to create a
70+
remote gist. You can easily create a new code snippet/gist object using
71+
<code>NgxGist.create({{ '{' }} ... {{ '}' }})</code>. Note: no "Open
72+
Gist on GitHub" link will display.
7273
</p>
7374
<ngx-gist [gist]="localGistObject"></ngx-gist>
7475

0 commit comments

Comments
 (0)