Description
WP Github provides three sidebar widgets which can be configured to display public profile, repositories, commits, issues and gists from github in the sidebar. You can have as many widgets as you want configured to display different repositories.
Currently the plugin can list:
- Profile
- Repositories
- Commits
- Issues
- Gists
- Pull request
- Single Issue
- Embed File content (with highlighter)
Using CSS
The plugin uses a basic unordered lists to enumerate. In the future will be implemented a simple template system to increase the customization.
You can apply a customized style to the plugin simply uploading a file called custom.css
in the plugin folder. It will allow you to upgrade the plugin without loss your custom style.
Caching
The plugin caches all the data retrieved from Github every 10 minutes to avoid exceed the limit of api calls.
Since version 1.1 you can clear the cache from the plugin settings page located in the WordPress settings menu.
Since version 1.2.6 you can add your github credentials
Support
If you have found a bug/issue or have a feature request please report here: https://github.com/seinoxygen/wp-github/issues
Screenshots
Installation
- Upload
wp-github
directory to the/wp-content/plugins/
directory - Activate the plugin through the ‘Plugins’ menu in WordPress
- Add the widget through the ‘Widgets’ menu in WordPress or add the desired shortcode in your posts and pages.
FAQ
- Which shortcodes are available?
-
You can use the following codes to display profile, repositories, commits, issues and gists:
Embeed profile:
[github-profile username=»seinoxygen»]
List last 10 repositories:
[github-repos username=»seinoxygen» limit=»10″]
List last 10 commits from all repositories:
[github-commits username=»seinoxygen» limit=»10″]
List last 10 commits from a specific repository:
[github-commits username=»seinoxygen» repository=»wp-github» limit=»10″]
List last 10 issues from all repositories:
[github-issues username=»seinoxygen» limit=»10″]
List last 10 issues from a specific repository:
[github-issues username=»seinoxygen» repository=»wp-github» limit=»10″]
List last 10 gists from a specific user:
[github-gists username=»seinoxygen» limit=»10″]
Contributors & Developers
“WP Github” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “WP Github” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.3.3
fix all issues
1.3.2
add access token
fix widget commits «all» repo option
1.3.1
- Fix: gravatar profile
1.3
- New: Added shortcode button in tinyMce
- New: Added documentation in setting page
1.2.7
- New: Embed file content.
- Default username and repository, no need to add them eachtime.
- Added i18n
1.2.6
- New: Several fixes.
- New: Language support.
- New: Added shortcodes to link to issues and pull-requests.
- New: Display single issue.
1.2
- New: Custom styles.
- New: List all issues and commits from all public repositories
1.1
- New: Added «clear cache» and «cache time» functionality in settings page.
- New: Added profile widget and shortcode.
1.0
- First release