Skip to content

Angular 4 Component for embedding a gist within an Angular site

License

Notifications You must be signed in to change notification settings

jasonhodges/ngx-gist

Repository files navigation

ngx-gist

Build Status semantic-release Commitizen friendly

Angular 4 Component for embedding a gist within an Angular site

Code Example

In order to use the component in your Angular 4 project after installation, follow these steps:

  • Declare NgxGistModule within app.module.ts
import { NgxGistModule } from 'ngx-gist/dist/ngx-gist.module';
 @NgModule({
   declarations: [
     AppComponent
   ],
   imports: [
     BrowserModule,
     FormsModule,
     HttpModule,
     NgxGistModule
   ],
   providers: [],
   bootstrap: [AppComponent]
 })
 export class AppModule { }
  • Use the ngx-gist component in any template files by using the ngx-gist tag along with username and gistId
<ngx-gist [gistId]="'{username}/{gistId}'"></ngx-gist>
  • Updated Support For Particular File in a gist
<ngx-gist [gistId]="'{username}/{gistId}'" [file] = "'<name of the file in gist>'"></ngx-gist>

the file parameter is a optional paramater

Motivation

This project was initiated after a search for an Angular 4 component of its kind returned no results.

Installation

npm i --save ngx-gist

Contributors


Jason Hodges

📖
Rahul Singh

📖

License

MIT