Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 3.73 KB

README.md

File metadata and controls

85 lines (56 loc) · 3.73 KB
Raw

Github Ribbon

Contributors: sudar
Tags: github, ribbon, git
Requires at least: 3.8
Donate Link: http://sudarmuthu.com/if-you-wanna-thank-me
Tested up to: 4.2.3
Stable tag: 1.2.1

Adds "Fork me on Github" ribbons to your WordPress posts

Description

Github Ribbons is a WordPress Plugin that allows you to add "Fork me on Github" ribbons to your WordPress posts or pages. You can enable the ribbon per post/page level or at global level.

Features

The following are some of the features of the Plugin

  • You can choose between image based ribbons or CSS3 based ribbons.
  • You can choose whether to show the ribbon on the right side or on the left side.
  • You can choose whether the link has to open in a new tab or not.
  • You can choose any one of the 6 different colours that are available.
  • Configuration can be set either globally or on a post by post basic.

Styling using CSS

If you want to style the ribbon yourself or add additional CSS styles to it (like adding z-index etc) then add it to the .robbon-holder CSS class.

Development

The development of the Plugin happens over at github. If you want to contribute to the Plugin, fork the project at github and send me a pull request.

If you are not familiar with either git or Github then refer to this guide to see how fork and send pull request.

If you are looking for ideas, then you can start with one of the following TODO items :)

TODO

The following are the features that I am thinking of adding to the Plugin, when I get some free time. If you have any feature request or want to increase the priority of a particular feature, then let me know.

  • Add an ability to translate the text used inside the ribbon

Support

  • If you have found a bug/issue or have a feature request, then post them in github issues
  • If you have a question about usage or need help to troubleshoot, then post in WordPress forums or leave a comment in Plugins's home page
  • If you like the Plugin, then kindly leave a review/feedback at WordPress repo page.
  • If you find this Plugin useful or and wanted to say thank you, then there are ways to make me happy :) and I would really appreciate if you can do one of those.
  • Checkout other WordPress Plugins that I have released.
  • If anything else, then contact me in twitter.

Translation

  • Dutch (Thanks Rene of WPwebshop)
  • Spanish (Thanks Mike Arias of InMotion Hosting)
  • Hindi (Thanks Love Chandel)
  • Lithuanian (Thanks Vincent G)
  • German (Thanks Robert Wetzlmayr)

The pot file is available with the Plugin. If you are willing to do translation for the Plugin, use the pot file to create the .po files for your language and let me know. I will add it to the Plugin after giving credit to you.

Installation

Extract the zip file and just drop the contents in the wp-content/plugins/ directory of your WordPress installation and then activate the Plugin from Plugins page.

Screenshots

Plugin in action in author's blog

Configuration screen

Readme Generator

This Readme file was generated using wp-readme, which generates readme files for WordPress Plugins.