An open API service indexing awesome lists of open source software.

https://github.com/remarkablemark/github-corners

:octocat: Github Corners embed script.
https://github.com/remarkablemark/github-corners

embed fork-me github github-corner github-corners javascript

Last synced: 6 months ago
JSON representation

:octocat: Github Corners embed script.

Awesome Lists containing this project

README

          

# github-corners

[![NPM](https://nodei.co/npm/github-corners.png)](https://nodei.co/npm/github-corners/)

[![NPM version](https://img.shields.io/npm/v/github-corners.svg)](https://www.npmjs.com/package/github-corners)

:octocat: [Github Corners](http://tholman.com/github-corners) embed script inspired by [Tim Holman](https://github.com/tholman).

### Examples

- [JSFiddle](https://jsfiddle.net/remarkablemark/f19eejcb/)
- [Replit](https://replit.com/@remarkablemark/Github-Corners)

## Usage

Include the [embed script](https://unpkg.com/github-corners/) on your webpage:

```html

```

Specify a [version](https://registry.npmjs.org/github-corners) to prevent breaking changes:

```html

```

Improve page loading with `async` or `defer` attribute:

```html

```

## FAQ

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

Set it with the `data-href` attribute:

```html

```

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

Set `data-target` to `_blank`:

```html

```

Can I change the `aria-label` of the link?

Yes, the `data-label` value will override the default value:

```html

```

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

You can always override the default styling of the svg:

```html

.github-corner > svg {
fill: skyblue;
}

```

## License

[MIT](LICENSE)

See [license/acknowledgements](https://github.com/tholman/github-corners#licenseacknowledgements) from original project.