@fireflysemantics/fs-gist

A web component for including gists in html content

Usage no npm install needed!

<script type="module">
  import fireflysemanticsFsGist from 'https://cdn.skypack.dev/@fireflysemantics/fs-gist';
</script>

README

fs-gist

Web component for embedding gists in html content

Installation

npm i @fireflysemantics/fs-gist

Usage

Include fs-gist via CDN like this in your html page:

<script src="https://unpkg.com/@fireflysemantics/fs-gist"></script>

To show this gist url:

https://gist.github.com/fireflysemantics/054716730103cd205c39167054542f68

configure the component gistURL like this:

<body style="height: 100vh;">
  <fs-gist gistURL="https://gist.github.com/fireflysemantics/054716730103cd205c39167054542f68">
  </fs-gist>
</body>

or configure the component gistID like this:

<body style="height: 100vh;">
  <fs-gist gistID="fireflysemantics/054716730103cd205c39167054542f68">
  </fs-gist>
</body>

Note that we set the height of the body to 100vh in order to allow fs-gist to expand.

A height property is also supported. For example:

<body style="height: 100vh;">
  <fs-gist height="10rem" gistID="fireflysemantics/054716730103cd205c39167054542f68">
  </fs-gist>
</body>

Stackblitz Demo

Development

Baseline

The project baseline is based on the Lit Element Typescript Starter Project.

Package

This project uses the build configuration from the rollup starter app as well as the rollup.config.js example configuration found in the Lit Element Typescript Starter Project.