Skip to content

v20.3.6 - Quick readme and package updates. #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 8, 2025
Merged

v20.3.6 - Quick readme and package updates. #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b2df1e
Quick update to README and packages (security updates).
CodyTolene Nov 8, 2025
a814ea7
Add pull request template
CodyTolene Nov 8, 2025
0c63350
Quick readme updates suggestions added.
CodyTolene Nov 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Description

A brief overview of your completed or ongoing work.

### Developement Checklist

- [ ] Bump version up (`package.json` **and** `package-lock.json`)

### Preview(s)

- Add screenshots, gifs, videos, etc. here for a quick preview if applicable.
60 changes: 32 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
<p align="center">
<div align="center">
<a href="https://www.ProAngular.com" target="_blank">
<img src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/public/images/pro-angular-logo.png" />
</a>
<h1 align="center">
<a href="https://www.ProAngular.com" target="_blank">
Pro Angular
</a>: GitHub Gist Code Snippet Viewer
<a href="https://www.ProAngular.com" target="_blank">Pro Angular</a>: ngx-gist
</h1>
</p>
<a align="center" href="https://github.com/ProAngular/ngx-gist" target="_blank">
View GitHub Repository
</a>
<p align="center">
An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.
</p>
</div>

<!---------------------------------------------------------------------------->
<!---------------------------------------------------------------------------->
Expand Down Expand Up @@ -74,12 +78,12 @@ More info in the following links:

## Description <a name="description"></a>

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.
Behold, this package contains an Angular Material and Highlight.js 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.

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

Expand Down Expand Up @@ -297,17 +301,17 @@ Line numbers are enabled by default, but you can turn them off like so.

## Compatibility <a name="compatibility"></a>

| Angular version | @proangular/ngx-gist | Install |
| --------------- | -------------------- | ------------------------------------- |
| v20 | v20.x.0 | `ng add @proangular/ngx-gist@^20.0.0` |
| v19 | v19.x.0 | `ng add @proangular/ngx-gist@^19.0.0` |
| v18 | ------ | Untested |
| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` |
| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` |
| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` |
| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
| Angular version | @proangular/ngx-gist | Install |
| --------------- | -------------------- | ------------------------------------ |
| v20 | v20.x | `ng add @proangular/ngx-gist@^20` |
| v19 | v19.x | `ng add @proangular/ngx-gist@^19` |
| v18 | ------ | Untested |
| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` |
| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` |
| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` |
| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |

<p align="right">[ <a href="#index">Index</a> ]</p>

Expand Down Expand Up @@ -369,12 +373,12 @@ Thank you to the entire Angular team and community for such a great framework to
build upon. If you have any questions, please let me know by opening an issue
[here][url-new-issue].

| Type | Info |
| :------------------------------------------------------------------------ | :------------------------------------------------------------- |
| <img width="48" src=".github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
| <img width="48" src=".github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
| <img width="48" src=".github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
| <img width="48" src=".github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |
| Type | Info |
| :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |

Fin. Happy programming friend!

Expand Down
20 changes: 10 additions & 10 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@proangular/ngx-gist",
"version": "20.3.5",
"version": "20.3.6",
"description": "An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.",
"author": "Pro Angular <webmaster@proangular.com>",
"homepage": "https://www.proangular.com",
Expand Down