Easily add a GitHub Fork Me button to any page!
Show your support!
A custom web element to easily add a GitHub Fork Me ribbon to your web pages!
You can view a demo of this Web Component in use here.
How to use GitHub Ribbon Web Component:
Add a github-ribbon element in your HTML document with your link etc like the example below -
<github-ribbon link="https://github.com/MarketingPipeline/GitHub-Ribbon-Web-Component/"></github-ribbon>include this script in your HTML document.
<script src="https://cdn.jsdelivr.net/gh/MarketingPipeline/GitHub-Ribbon-Web-Component/dist/github-ribbon-wc.min.js" defer></script>
| Attribute | Meaning | Default | Required |
|---|---|---|---|
| link | The link to your GitHub repo / source code etc... | undefined |
Yes |
| side | Change the side of the ribbon, options are top-left, top-right, bottom-right, bottom-left |
top-right |
No |
| message | Set your own custom message instead of "Fork me on GitHub" | undefined |
No |
| color | Change the color of the ribbon background | red |
No |
| text-color | Change the text color of the ribbon | #fff |
No |
| new-window | If True, link with open in a new window |
False |
No |
| fixed | If False non fixed CSS will be applied |
True |
No |
Want to improve this? Create a pull request with detailed changes / improvements! If approved you will be added to the list of contributors of this awesome project!
See also the list of contributors who participate in this project.
This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details.