kennethrapp

<p>GitSwag displays data from a Github account using Github’s public API. In order to avoid<br />
rate-limiting, it caches the JSON from the API locally, and refers to that whenever<br />
available. You can display a user profile, list of repositories, header for a single<br />
repository, preview files or gists.</p>
<h3>Administration</h3>
<p>In “GitSwag” under the settings tab, enter your github username, select the<br />
“update cache” checkbox and submit to change your username. Files under that<br />
username can be deleted by checking the box next to the file and submitting.</p>
<p>Any changes you make to your github repo won’t be reflected immediately by<br />
the plugin, you’ll have to manually delete the cache first.</p>
<h3>Composer Updating</h3>
<p>This plugin includes <a href="Composer" rel="nofollow ugc">http://getcomposer.org</a> and an autoloader to implement<br />
the <a href="Parsedown" rel="nofollow ugc">http://parsedown.org/</a> library.</p>
<p>To save a bit of space, composer.phar isn’t included with this plugin.</p>
<p>Parsedown is [https://github.com/erusev/parsedown/blob/master/LICENSE.txt](MIT licensed)</p>
<h3>Shortcode</h3>
<p>Display the profile of a single user<br />
[gitswag_user_view github_username=”username”]</p>
<p>Display a list of repos for a user<br />
[gitswag_repo_list github_username=”username”]</p>
<p>View data for a repository<br />
[gitswag_repo_view github_username=”username” github_repo=”reponame”]</p>
<p>Preview a file<br />
[gitswag_file_view github_username=”username” github_repo=”reponame” path=”path/to/” filename=”file.txt”]</p>
<p>List gists by a user<br />
[gitswag_gist_list github_username=”username”]</p>
<p>Preview a gist<br />
[gitswag_gist_view gist_id=”id”]</p>
<p>display the readme for a repo<br />
[gitswag_readme github_username=”username” github_repo=”reponame”]</p>
<h3>Administration</h3>
<p>Because the public github API is rate limited, this plugin will download and keep a cached<br />
version of the .json files and readme markdown from API calls locally, and will need to be deleted<br />
in the admin panel when a change needs to be reflected. You can select a file and submit to delete them.</p>


GitSwag

Integrate various Github API-driven shortcodes into your pages.

IvanRF

<p><a href="https://ivanrf.com/en/github-release-downloads/" rel="nofollow ugc">GitHub Release Downloads</a> allows you to get the download count, links and more information for releases of GitHub repositories.</p>
<h4>Download count</h4>
<p>The shortcode is <code>[grd_count]</code>. It returns a number corresponding to the sum of all download count values for the selected releases. For instance, you can get the number of total downloads for one GitHub repository.</p>
<p>Attributes</p>
<ul>
<li><code>user</code>: the GitHub username.</li>
<li><code>repo</code>: the GitHub repository name.</li>
<li><code>latest</code>: only gets information about the latest published release for the repository.</li>
<li><code>tag</code>: only gets information about the release with the specified tag name.</li>
<li><code>prereleases</code>: includes draft releases and prereleases. Default value is <code>false</code>.</li>
</ul>
<p>Examples</p>
<ul>
<li>All repository downloads:   <code>[grd_count user="IvanRF" repo="MassiveFileRenamer"]</code></li>
<li>Latest release downloads:   <code>[grd_count user="IvanRF" repo="MassiveFileRenamer" latest="true"]</code></li>
<li>Specific release downloads: <code>[grd_count user="IvanRF" repo="MassiveFileRenamer" tag="v1.6.0"]</code></li>
</ul>
<p>Note: <code>user</code> and/or <code>repo</code> can be omitted if default values are set.</p>
<h4>Release downloads list</h4>
<p>The shortcode is <code>[grd_list]</code>. It returns an HTML list for the selected releases including the release tag name, the release description and the list of files that can be downloaded, like release assets or the source code.<br />
For styling, class selectors are provided (e.g.: <code>release-downloads-header</code>, <code>release-name</code>, etc.).</p>
<p>Attributes</p>
<ul>
<li><code>user</code>, <code>repo</code>, <code>latest</code>, <code>tag</code>, <code>prereleases</code>: same as above.</li>
<li><code>hide_description</code>: hides the release description.</li>
<li><code>hide_size</code>: hides information about the file size.</li>
<li><code>hide_downloads</code>: hides information about the download count.</li>
<li><code>downloads_suffix</code>: use it for internationalization. Default value is <code>" downloads"</code>.</li>
<li><code>hide_source_code</code>: hides the download link for the source code.</li>
</ul>
<p>Examples</p>
<ul>
<li>All repository downloads:   <code>[grd_list user="IvanRF" repo="MassiveFileRenamer"]</code></li>
<li>Latest release downloads:   <code>[grd_list user="IvanRF" repo="MassiveFileRenamer" latest="true"]</code></li>
<li>Specific release downloads: <code>[grd_list user="IvanRF" repo="MassiveFileRenamer" tag="v1.5.6"]</code></li>
<li>Hide file size:             <code>[grd_list user="IvanRF" repo="MassiveFileRenamer" hide_size="true"]</code></li>
<li>Hide downloads count:       <code>[grd_list user="IvanRF" repo="MassiveFileRenamer" hide_downloads="true"]</code></li>
<li>Downloads suffix change:    <code>[grd_list user="IvanRF" repo="MassiveFileRenamer" downloads_suffix="descargas"]</code></li>
</ul>
<p>Boolean attributes can take any of this values: “1”, “true”, “on” and “yes”; or “0”, “false”, “off” and “no”.</p>
<h4>Latest version</h4>
<p>The shortcode is <code>[grd_latest_version]</code>. It returns the tag name of the latest published full release.<br />
For tag names like “v1.6.0”, it returns “1.6.0” as the version number.</p>
<p>Attributes</p>
<ul>
<li><code>user</code>, <code>repo</code>, <code>prereleases</code>: same as above.</li>
</ul>
<h4>Settings</h4>
<p>Under WordPress <strong>Settings</strong> menu you will find the <strong>GitHub Release Downloads</strong> options page. In this page you can set values for the GitHub username and the repository name to use by default in the shortcodes.</p>
<p>If both values are set, the shortcodes can be used without attributes (e.g.: <code>[grd_count]</code>) since default values for <code>user</code> and <code>repo</code> will be used.<br />
Attribute values take precedence over default values. For example, <code>[grd_count repo="MyRepo"]</code> will use the username default value and the repository specified in the shortcode.</p>


GitHub Release Downloads

Get the download count, links and more information for releases of GitHub repositories.

GitSwag vs GitHub Release Downloads