A modern and global open source fork corner label for your project's landing page.
What is Fork Corner
A modern approach to the old style of adding "Fork Me" ribbon or label in an open source project's landing page.
Fork corner generator page coming soon...
Fork Corner is responsive to any screen sizes. Focus on your landing page while fork corner do the rest of responsive design.
It uses class to quickly customize your Fork Corner. It allows you to change themes, animations, and which want you want to position your Fork Corner. You can edit the source file if you want more advance customization.
Fork Corner is very lightweight and optimized so don't worry about the performance of your landing page.
Install with npm:
$ npm i fork-corner --save
or add it directly to your webpage using a CDN:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/fork-corner/dist/fork-corner.min.css"> <script src="https://cdn.jsdelivr.net/npm/fork-corner/dist/fork-corner.min.js" defer></script>
After installing Fork Corner simply add this one line of code to the
<body> of your webpage:
<a href="https://github.com/user/repo" target="_blank" id="fork-corner" class="fork-corner fc-pos-tr fc-animate fc-theme-git"></a>
Fork Corner uses
fork-corner as ID to identify which element should be use in creating the fork corner. The class
fork-corner is use to identify which element to be controlled by the class. We have few important classes to quickly customize the fork corner's look and feel.
Class to position the Fork Corner on your webpage. By default, the position is
||Top, Right, Sticky|
||Top, Left, Sticky|
||Bottom, Right (sticky by default)|
||Bottom, Left (sticky by default)|
Class to animate the Fork Corner on your webpage. By default, when you hover your mouse to the icon it will rotate.
||Icon rotation on cursor hover|
||Icon slide up on cursor hover|
||Icon slide down on cursor hover|
||Icon grow on cursor hover|
||Icon shrink on cursor hover|
||Icon fade out on cursor hover|
More animation will come, have animation in mind? Contribute today!
Class to select pre-defined theme or style you want to use. By default, it will show the official Git logo.
More theme and brand will come, have one in mind? Contribute today!
Class to select pre-defined corner size. By default, it is set as 200px. To set the default size just don't add the size class.
||150px corner size|
||250px corner size|
||300px corner size|
If you're looking for specific size please edit the source file and build it.
Wanna see your project here? Let us know!
Working on custom logo...
Contributions are welcome, create a pull request to this repo and I will review your code. Please consider to submit your pull request to the
dev branch. Thank you!
If you're facing a problem in using Fork Corner please let me know by creating an issue in this github repository. I'm happy to help you! Don't forget to provide me some screenshot or error logs of it, thank you!
Wanna see other projects I made? Join today!
Fork Corner is licensed under MIT - https://opensource.org/licenses/MIT
Fork Corner is Developed and Maintained by Waren Gonzaga