Skip to content

README.md

Latest commit

 

History

History
57 lines (46 loc) · 1.53 KB

README.md

File metadata and controls

57 lines (46 loc) · 1.53 KB

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>

Options

gist

The id of the gist. Can be obtained by the url.

preview-page (optional)

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

default-branch (optional)

The name of the default branch. Defaults to master.

This project is supported by ZingSoft creators of the web component datagrid library ZingGrid and the JavaScript charting library ZingChart.