Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sgbj/angular-gist

Embed GitHub Gists in your Angular apps without an iframe
https://github.com/sgbj/angular-gist

Last synced: 8 days ago
JSON representation

Embed GitHub Gists in your Angular apps without an iframe

Awesome Lists containing this project

README

        

# [@sgbj/angular-gist](https://www.npmjs.com/package/@sgbj/angular-gist)

Embed GitHub Gists in your Angular apps without an iframe.

## Installation

To install this library, run:

```bash
$ npm install @sgbj/angular-gist --save
```

## Consuming your library

Once you have published your library to npm, you can import your library in any Angular application by running:

```bash
$ npm install @sgbj/angular-gist
```

and then from your Angular `AppModule`:

```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// Import your library
import { GistModule } from '@sgbj/angular-gist';

@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,

// Specify your library as an import
GistModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
```

Once your library is imported, you can use its components, directives and pipes in your Angular application:

```ts
@Component({
selector: 'app',
template: ``
})
class AppComponent {
}
```

[View demo.](https://stackblitz.com/edit/angular-dnbv3e)

## Development

To generate all `*.js`, `*.d.ts` and `*.metadata.json` files:

```bash
$ npm run build
```

To lint all `*.ts` files:

```bash
$ npm run lint
```

## License

MIT © [sgbj](mailto:[email protected])