@haxtheweb/github-preview

9.0.18 • Public • Published

<github-preview>

Preview

A simple element that displays information about a github repository.

Usage

To use this web component in your project you can utilize one of the following styles of syntax.

/* In an existing JS module / web component */
import '@haxtheweb/github-preview/github-preview.js';

/* CDN */
<script type="module" src="https://cdn.hax.cloud/cdn/build/es6/node_modules/@haxtheweb/github-preview/github-preview.js"></script>

Develop / Demo

Run npm start will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src directory for changes and automatically rebuilding the element and documentation site for the demo.

$ npm start

Contributing

  1. Fork it! git clone https://github.com/haxtheweb/webcomponents.git
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Code style

Preview use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.

License

MIT License

Package Sidebar

Install

npm i @haxtheweb/github-preview

Weekly Downloads

48

Version

9.0.18

License

Apache-2.0

Unpacked Size

189 kB

Total Files

18

Last publish

Collaborators

  • btopro