Description
๐ฃ WordPress plugin to show Github profile summary through their API.
โก๏ธ Demo: https://manojkumar.online/lab/wp/github-flair-demo/
After installing the plugin, just use this shortcode: [github-flair]
in your posts, pages or widgets.
You can make use of the user attribute of the shortcode like this:
[github-flair user="WordPress"]
where WordPress can be replaced by your desired Github username.
By default, the search function is enabled but if you need to remove it, you can do so with:
[github-flair show-search="no"]
You can also make use of the shortcode in your template files using this
<?php echo do_shortcode("[github-flair user='WordPress']") ; ?>
Screenshots
FAQ
-
Do I need an API key to access GitHub key?
-
You might not need an API key for now since GitHub offers unauthenticated access up to certain limit. Please read this: https://docs.github.com/en/rest/guides/getting-started-with-the-rest-api which says that they allow up to 60 requests per hour per user. So they block the IP for a while if they exceed that limit.
The admin inputs for API key will be in the future releases if people find it interesting to work with.
-
How do I limit the number of search results?
-
Make use of the attribute
[github-flair total-results="25"]
where you can set any number instead of 25. -
I need to add/delete details to/from these cards.
-
You can do so if you are a developer by editing the script.js file and getting the desired results from the API into the HTML and then minify it. As a non-developer, You can request more profile data through https://github.com/M4N0JKUM4R/Flair-Github/issues
Reviews
There are no reviews for this plugin.
Contributors & Developers
“Flair – Github” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “Flair – 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.0.1
* Fixed JS errors on non-shortcode pages. Added option to limit the number of search results.
= 1.0.0
* Early release with basic rendering of cards with a search function.