github-corners

Embed script for GitHub Corners.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
github-corners
0.1.05 years ago5 years agoMinified + gzip package size for github-corners in KB

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.