Coder Social home page Coder Social logo

angular-gist's Introduction

Embed GitHub Gists in your Angular apps without an iframe.

Installation

To install this library, run:

$ 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:

$ npm install @sgbj/angular-gist

and then from your Angular AppModule:

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:

@Component({
  selector: 'app',
  template: `<gh-gist src="https://gist.github.com/sgbj/95ab8e2e77150318e7bd25b8d00a3248.js"></gh-gist>`
})
class AppComponent {
}

View demo.

Development

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

$ npm run build

To lint all *.ts files:

$ npm run lint

License

MIT © sgbj

angular-gist's People

Contributors

sgbj avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

angular-gist's Issues

Can't resolve 'postscribe'

I'm getting the following error after importing to app.module.ts and pasting the html into one of my components.

./node_modules/@sgbj/angular-gist/angular-gist.umd.js
Module not found: Error: Can't resolve 'postscribe' in '/.../node_modules/@sgbj/angular-gist'
 @ ./node_modules/@sgbj/angular-gist/angular-gist.umd.js 2:135-156
 @ ./src/app/dna.module.ts
 @ ./src/main.ts
 @ multi webpack-dev-server/client?http://0.0.0.0:0 ./src/main.ts

Error: Can't resolve 'angular-gist'

ng build --prod results in following error:
ERROR in ./node_modules/@sgbj/angular-gist/angular-gist.ngfactory.js
Module not found: Error: Can't resolve 'angular-gist' in '......./node_modules/@sgbj/angular-gist'
ERROR in ./src/app/app.module.ngfactory.js

Add option to pick file when a gist has multiple files

Check out this sample gist . It has two files in it angular-example-gist.ts and angular-example-gist2.ts. Using angular-gist, it will render all the files in the gist. I'd like for there to be an extra parameter or something to specify which file to render when the gist contains multiple files :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.