Git-view NPM | npm.io

git-view

A native web component to view a GitHub repo or gist's files along with displaying a preview in HTML.

Git Usage (Github only)

Loads a github repository, and previews from github pages.

  <!doctype html>
  <html lang="en">
    <head>
      <meta charset="UTF-8" />
      <title>Hello git-view</title>
      <script src="path/to/dist/git-view.min.js>
    </head>
    <body>
      <git-view repo="zingchart/vue-dashboard" preview-branch="gh-pages" preview-page="index.html"></git-view>
    </body>
  </html>

Options

`repo`

A string containing the [owner]/[repo]

`preview-branch` (optional)

The branch of which to set the preview. Defaults to gh-pages.

`preview-page` (optional)

The page to render as the preview. Defaults to index.html.

Gist usage

  <!doctype html>
  <html lang="en">
    <head>
      <meta charset="UTF-8" />
      <title>Hello git-view gist </title>
      <script src="path/to/dist/git-view.min.js>
    </head>
    <body>
      <git-view gist="5e6334bf6195c979bb32de85354876c2"></git-view>
    </body>
  </html>