<gh-corner>

A simple web-component wrapper around github-corners.

This component is intended for use in pages that already make use of lit though it works fine in plain pages as well, just with some additional overhead.

This webcomponent follows the open-wc recommendation.

Installation

npm i gh-corner

Usage

<script type="module">
  import 'gh-corner/gh-corner.js';
</script>

<gh-corner user="USERNAME" repo="REPOSITORY" position="left|right"></gh-corner>

or using a CDN:

<script type="module" src="https://unpkg.com/gh-corner-wc/gh-corner.js?module">
</script>

<gh-corner user="USERNAME" repo="REPOSITORY" position="left|right"></gh-corner>

Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode run:

npm run test:watch

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

npm run storybook:build

Tooling configs

For most of the tools, the configuration is in the package.json to minimize the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html