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

Package detail

fork-me-github

davidfig18MIT1.2.0

Programatically add fork me on github ribbon from javascript without making changes to CSS, HTML, or adding image files

fork, github, ribbon, fork me on github, javascript

readme

fork-me-github

Programatically add fork me on github ribbon from javascript without making changes to CSS, HTML, or adding image files

Rationale

Wanted an easy way to add a "fork me on github" ribbon using plain javascript without changing CSS, HTML, or adding an image file.

Simple Example

const ForkMe = require('fork-me-github')
ForkMe('https://github.com/davidfig/fork-me-github/)

Live Example

https://davidfig.github.io/fork-me-github/

Installation

npm i fork-me-github

API Reference

Inspiration

Ribbon uses Simon Whitaker's github-fork-ribbon-css, which is based on Github's ribbon examples

Similar plugins

Merrier's github-fork-ribbon-normal plugin is very similar, and something I probably would have used if I had found it before writing this one.

license

MIT License
(c) 2017 YOPEY YOPEY LLC by David Figatner