Plugin info

Total downloads: 1,063
Active installs: 0
Total reviews: 0
Average rating: 0
Support threads opened: 0
Support threads resolved: 0 (0%)
Available in: 1 language(s)
Contributors: 1
Last updated: 6/13/2014 (4219 days ago)
Added to WordPress: 12/30/2013 (12 years old)
Minimum WordPress version: 3.2
Tested up to WordPress version: 3.7.41
Minimum PHP version: f

Maintenance & Compatibility

Maintenance score

Possibly abandoned • Last updated 4219 days ago

20/100

Is GitSwag abandoned?

Possibly abandoned (last update 4219 days ago).

Compatibility

Requires WordPress: 3.2
Tested up to: 3.7.41
Requires PHP: f

Similar & Alternatives

Explore plugins with similar tags, and compare key metrics like downloads, ratings, updates, support, and WP/PHP compatibility.

Github Embed
Rating 3.9/5 (14 reviews)Active installs 1,000
Jekyll Exporter
Rating 3.5/5 (12 reviews)Active installs 700
Pastacode
Rating 4.9/5 (14 reviews)Active installs 500
Embed Block for GitHub
Rating 4.2/5 (5 reviews)Active installs 500
Gist GitHub Shortcode
Rating 5.0/5 (6 reviews)Active installs 200
WordPress GitHub Sync
Rating 5.0/5 (4 reviews)Active installs 200

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 http://getcomposer.org and an autoloader to implement
the http://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.

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.

Frequently Asked Questions

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.

Review feed

No reviews available

Screenshots

  1. user profile

    user profile

  2. repo file view

    repo file view

  3. repo list view

    repo list view

Changelog

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

1.0 works