Better ways to advertise your GitHub project.
Using features such as GitHub ribbons, buttons, and more!
When you have an open-source project, you might want to advertise to let other people know. How do you do this? In this tutorial, I will teach you how to use github:buttons, GitHub corners, and GitHub ribbons.
github:buttons
github:buttons are a good way to get coverage on your project, using simple “social-media” like buttons.
Creating a follow button:
A follow button is a button that links to a GitHub user page and prompts the user to follow the user. Here’s how to create one:
- Go onto github:buttons
- Click “Follow”
3. Place your GitHub username in the box labeled “:user”
4. Customize the button using the boxes “Large button”, “Show count”, and “Standard icon”. You can end up with buttons that look like this:
5. Place this code in the <head> or before the end of the <body> of your code:
6. Place the customized button rendering code in your code.
Video tutorial:
Creating other buttons:
All of the other buttons you can create, are buttons that link to a GitHub repository and prompts the user to complete a certain action. These buttons can do actions such as:
- Watch a repository
- Star a repository
- Fork a repository
- Download a repository
- List an Issue with a repository
Here’s how to create some:
- Go onto github:buttons
- Click the button type you want to create (Watch, Star, Fork, Download, or Issue)
3. Place your GitHub username in the box labeled “:user”, and your repository in the box “:repo”
4. Customize the button using the boxes “Large button”, “Show count”, and “Standard icon” You can end up with buttons that look like this:
5. Place this code in the <head> or before the end of the <body> of your code:
6. Place the customized button rendering code in your code:
GitHub Corners
GitHub Corners are a good way to show in a simple way, a link to your project’s GitHub repository
There are two ways to create GitHub Corners. The modern kind, or the ribbon kind. The first example I’m showing you how to do, is to create the modern kind.
- Go to http://tholman.com/github-corners/
- Copy the code that corresponds with the corner you like the most.
- Put the code in your code.
Examples:
GitHub Ribbons
Now, the ribbon kind. This is the less fashionable kind.
- Go to https://github.com/blog/273-github-ribbons
- Copy the code that corresponds with the corner you like the most.
- Put the code in your code.
Examples:
Hopefully, using this blog post, you have learned to advertise your GitHub repository by using these nifty methods.
If you liked this article, please 👏 below, so that other people can find it! :D
