Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

github-corners

remarkablemark349MIT0.1.0

Embed script for GitHub Corners.

github-corners, github, corners

readme

github-corners

NPM

NPM version

Embed script for Tim Holman's Github Corners.

Installation

Include the embed script from the unpkg CDN in your page:

<!-- placed preferably before the closing `<body>` tag -->
<script src="https://unpkg.com/github-corners/dist/embed.min.js"></script>

It's recommended that you specify a version or you may experience breaking changes:

<!-- replace `latest` with a version like `0.1.0` -->
<script src="https://unpkg.com/github-corners@latest/dist/embed.min.js"></script>

Usage

So the GitHub Corner renders on your page. Great! But how do I specify a link?

You can set it using the data-href attribute:

<script data-href="https://github.com/tholman/github-corners" src="https://unpkg.com/github-corners/dist/embed.min.js"></script>

Now what if I want the link to open in a new tab?

Set data-target to _blank:

<script data-href="https://github.com/tholman/github-corners" data-target="_blank" src="https://unpkg.com/github-corners/dist/embed.min.js"></script>

And what if I want to change the color or position of the corner?

You can always override the default styling of the svg:

<!-- placed preferably after the embed script -->
<style>
.github-corner > svg {
  fill: skyblue;
}
</style>

License

MIT

See license/acknowledgements from original project.

changelog

Change Log

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

0.1.0 (2018-01-18)

Features

  • embed: create GitHub Corners embed script (56da801)
  • embed: refactor svg inline style to css style (5af4c1c)