https://github.com/warengonzaga/fork-corner

A modern and global open source fork corner label for your project's landing page.
https://github.com/warengonzaga/fork-corner

badge badges bitbucket bitbucket-corner corner corner-label fork fork-me github github-corner github-fork-coner gitlab gitlab-corner hacktoberfest labels landing-page modern ribbon ribbons webpage

Last synced: 2 months ago
JSON representation

A modern and global open source fork corner label for your project's landing page.

• Host: GitHub
• URL: https://github.com/warengonzaga/fork-corner
• Owner: warengonzaga
• License: mit
• Created: 2020-11-02T08:35:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-08T05:55:22.000Z (over 2 years ago)
• Last Synced: 2024-10-30T02:48:10.463Z (6 months ago)
• Topics: badge, badges, bitbucket, bitbucket-corner, corner, corner-label, fork, fork-me, github, github-corner, github-fork-coner, gitlab, gitlab-corner, hacktoberfest, labels, landing-page, modern, ribbon, ribbons, webpage
• Language: SCSS
• Homepage: https://fork-corner.warengonzaga.com
• Size: 328 KB
• Stars: 28
• Watchers: 4
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE
  • Code of conduct: code_of_conduct.md
  • Security: security.md

Awesome Lists containing this project

README

        
# Fork Corner [![Featured on Openbase](https://badges.openbase.com/js/featured/fork-corner.svg?style=openbase)](https://openbase.com/js/fork-corner?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge)

[![created by](https://img.shields.io/badge/created%20by-Waren%20Gonzaga-blue.svg?longCache=true&style=flat-square)](https://github.com/warengonzaga) [![release](https://img.shields.io/github/release/warengonzaga/fork-corner.svg?style=flat-square)](https://github.com/warengonzaga/fork-corner/releases) [![star](https://img.shields.io/github/stars/warengonzaga/fork-corner.svg?style=flat-square)](https://github.com/warengonzaga/fork-corner/stargazers) ![Size](https://img.shields.io/github/repo-size/warengonzaga/fork-corner?color=green&style=flat-square) ![NPM](https://img.shields.io/npm/dm/fork-corner?color=red&style=flat-square) ![jsdelivr](https://img.shields.io/jsdelivr/npm/hm/fork-corner?color=orange&style=flat-square) [![license](https://img.shields.io/github/license/warengonzaga/fork-corner.svg?style=flat-square)](https://github.com/warengonzaga/fork-corner/blob/main/license)

![Banner](./.github/img/fork-corner-github-banner.jpg)

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.

## 😎 Demo

Visit **[fork-corner.warengonzaga.com](https://fork-corner.warengonzaga.com)** for the demo.

Watch the video demo via **[Waren Gonzaga's YouTube Channel](https://www.youtube.com/watch?v=XYUxx-BvSYM)**.

> Fork corner generator page coming soon...

## 📖 Documentation

The complete documentation can be found here:

[![docs](https://img.shields.io/badge/Docs-docs.warengonzaga.com/fork--corner-blue.svg?longCache=true&style=for-the-badge)](https://docs.warengonzaga.com/fork-corner)

## ⚡ Features

    Modern Design


> _The Fork Corner design inspired by [Tholman's GitHub Corners](https://github.com/tholman/github-corners), I made my own version by adding more control to it using CSS and JS. Instead of using SVG I use icons from [Devicons](https://devicons.dev)._

    Responsive


> _Fork Corner is responsive to any screen sizes. Focus on your landing page while fork corner do the rest of responsive design._

    Customizable


> _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._

    Lightweight


> _Fork Corner is very lightweight and optimized so don't worry about the performance of your landing page._

    CSS3 Animations


> _Fork Corner author is a core contributor to the popular [animate.css](https://animate.style). You can customize your Fork Corner animations by using utility classes just like using [animate.css](https://animate.style) utility classes._

---

## 📦 Installation

Install with [npm](https://www.npmjs.com/package/fork-corner):

```bash

$ npm i fork-corner --save

```

or add it directly to your webpage using a CDN:

```html

```

## 🕹️ Usage

After installing Fork Corner simply add this one line of code to the ```` of your webpage:

```html



```

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.

### Position Class

Class to position the Fork Corner on your webpage. By default, the position is _``top right``_.

| Class | Position |

|-------|----------|

| ``fc-pos-tr`` | Top, Right |

| ``fc-pos-tl`` | Top, Left |

| ``fc-pos-tr-sticky`` | Top, Right, Sticky |

| ``fc-pos-tl-sticky`` | Top, Left, Sticky |

| ``fc-pos-br`` | Bottom, Right _(sticky by default)_ |

| ``fc-pos-bl`` | Bottom, Left _(sticky by default)_ |

### Animation Class

Class to animate the Fork Corner on your webpage. By default, when you hover your mouse to the icon it will rotate.

| Class | Animation |

|-------|-----------|

| ``fc-animate`` | Icon rotation on cursor hover |

| ``fc-animate-slideup`` | Icon slide up on cursor hover |

| ``fc-animate-slidedown`` | Icon slide down on cursor hover |

| ``fc-animate-grow`` | Icon grow on cursor hover |

| ``fc-animate-shrink`` | Icon shrink on cursor hover |

| ``fc-animate-fade`` | Icon fade out on cursor hover |

> More animation will come, have animation in mind? Contribute today!

### Theme Class

Class to select pre-defined theme or style you want to use. By default, it will show the official **Git** logo.

| Class | Theme/Brand |

|-------|-----------|

| ``fc-theme-animate`` | Git Logo |

| ``fc-theme-github`` | GitHub Logo |

| ``fc-theme-gitlab`` | Gitlab Logo |

| ``fc-theme-bitbucket`` | Bitbucket Logo |

> More theme and brand will come, have one in mind? Contribute today!

### Size Class

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.

| Class | Corner Size |

|-------|-----------|

| ``fc-size-small`` | 150px corner size |

| ``fc-size-medium`` | 250px corner size |

| ``fc-size-large`` | 300px corner size |

> If you're looking for specific size please edit the source file and build it.

## 🎯 Contributing

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!

Read the project's [contributing guide](./contributing.md) for more info.

## 💬 Discussions

For any questions, suggestions, ideas, or simply you want to share your experience in using this project, feel free to share and discuss it to the [community](https://github.com/warengonzaga/fork-corner/discussions)!

## 🐛 Issues

If you're facing a problem in using Fork Corner please let me know by [creating an issue here](https://github.com/warengonzaga/fork-corner/issues/new). I'm here to help you!

## 🍀 Sponsors and Supporters

[![BuyMeaCoffee](https://wrngnz.ga/badge-buymeacoffee)](https://buymeacoff.ee/warengonzaga) [![Vercel](https://wrngnz.ga/badge-vercel)](https://vercel.com) [![CircleCI](https://wrngnz.ga/badge-circleci)](https://vercel.com) [![GitBook](https://wrngnz.ga/badge-gitbook)](https://gitbook.io) [![Digital Ocean](https://wrngnz.ga/badge-digitalocean)](https://digitalocean.com) [![Deepware](https://wrngnz.ga/badge-deepware)](https://deepware.ai/) [![NOWPayments](https://wrngnz.ga/badge-nowpayments)](https://nowpayments.io) [![StackHawk](https://img.shields.io/badge/Stackhawk-%2300CBC6.svg?&style=for-the-badge&logoColor=white)](https://stackhawk.com)

> Love what I do? **[Send me some coffees](https://buymeacoff.ee/wareneutron)**!

>

> Your coffee donation and support will help me to continue working on open-source projects like this.

## 🌏 Community

Join to my growing tech community and get the latest updates!

[![community](https://discordapp.com/api/guilds/659684980137656340/widget.png?style=banner2)](https://wrngnz.ga/discord) [![community](https://discordapp.com/api/guilds/694612151444439081/widget.png?style=banner2)](https://wareneutron.com/discord)

## 📋 Code of Conduct

Read the project's [code of conduct](./code_of_conduct.md).

## 📃 License

Fork Corner is licensed under [The MIT License](https://opensource.org/licenses/MIT).

## 📝 Author

Fork Corner is created by **[Waren Gonzaga](https://github.com/warengonzaga)**, with the help of awesome [contributors](https://github.com/warengonzaga/fork-corner/graphs/contributors).

---

💻 Made with 💖 and ☕ by **Waren Gonzaga** with **YHWH** 🙏 | Citizen of Heaven

[personal website]: https://warengonzaga.com

[business website]: https://wgcompanyhq.com

[biolink]: https://bio.link/warengonzaga

[facebook]: https://facebook.com/warengonzagaofficial

[twitter]: https://twitter.com/warengonzaga

[instagram]: https://instagram.com/warengonzagaofficial

[youtube]: https://youtube.com/warengonzaga