GitSwag

Description

GitSwag displays data from a Github account using Github’s public API. In order to avoid
rate-limiting, it caches the JSON from the API locally, and refers to that whenever
available. You can display a user profile, list of repositories, header for a single
repository, preview files or gists.

Administration

In “GitSwag” under the settings tab, enter your github username, select the
“update cache” checkbox and submit to change your username. Files under that
username can be deleted by checking the box next to the file and submitting.

Any changes you make to your github repo won’t be reflected immediately by
the plugin, you’ll have to manually delete the cache first.

Composer Updating

This plugin includes https://getcomposer.org and an autoloader to implement
the https://parsedown.org/ library.

To save a bit of space, composer.phar isn’t included with this plugin.

Parsedown is [https://github.com/erusev/parsedown/blob/master/LICENSE.txt](MIT licensed)

Shortcode

Display the profile of a single user
[gitswag_user_view github_username=”username”]

Display a list of repos for a user
[gitswag_repo_list github_username=”username”]

View data for a repository
[gitswag_repo_view github_username=”username” github_repo=”reponame”]

Preview a file
[gitswag_file_view github_username=”username” github_repo=”reponame” path=”path/to/” filename=”file.txt”]

List gists by a user
[gitswag_gist_list github_username=”username”]

Preview a gist
[gitswag_gist_view gist_id=”id”]

display the readme for a repo
[gitswag_readme github_username=”username” github_repo=”reponame”]

Administration

Because the public github API is rate limited, this plugin will download and keep a cached
version of the .json files and readme markdown from API calls locally, and will need to be deleted
in the admin panel when a change needs to be reflected. You can select a file and submit to delete them.

Screenshots

Installation

1. Upload plugin-name.php to the /wp-content/plugins/ directory
2. Activate the plugin through the ‘Plugins’ menu in WordPress
3. Add some shortcodes.

FAQ

Can I clone/pull/push/whatever?

..no. Nothing that requires authentication is supported.

what’s to stop me from getting the data from someone else’s repo?

..nothing. It’s all public data anyway. Be nice.

this is missing an api feature

I’ll probably get around to it at some point.

Reviews

Contributors & Developers

Changelog

1.2 added output buffering and changed echoes to returns, fixing possible rendering issues. updated css.
1.1 bugfix

1.0 works