Claudio Sanches

<p>This plugin adds Github Gists in your posts via shortcode.</p>
<p><strong>Examples</strong></p>
<p>Add a full gist:</p>
<pre><code>[gist id="3837669"]
</code></pre>
<p>Add a specific file in a gist:</p>
<pre><code>[gist id="3837669" file="index.php"]
</code></pre>
<h3>License</h3>
<p>Gist GitHub Shortcode is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published<br />
by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>Gist GitHub Shortcode is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with Gist GitHub Shortcode. If not, see <a href="http://www.gnu.org/licenses/" rel="nofollow ugc">http://www.gnu.org/licenses/</a>.</p>


Gist GitHub Shortcode

Adds Github Gists in your posts via shortcode

Sudar Muthu

<p>WP Github Gist WordPress Plugin, provides the ability to embed gist and files from Github in your blog posts or pages. Even though Github doesn’t provide a way to embed files, this Plugin still works by using the gist-it service.</p>
<h3>Features</h3>
<h4>Embed Gist</h4>
<p>To embed a gist you have to use the following shortcode</p>
<pre><code>[gist id = "{GIST_ID}" file = "{GIST_FILE}" width = "{WIDTH}" height = "{HEIGHT}"]
</code></pre>
<p>The following are the different attributes that you can use in the shortcode</p>
<ul>
<li><code>id</code> – Id of your gist.</li>
<li><code>file</code> – File inside gist that you want to display. If there is only one file in the gist, then you can ignore this.</li>
<li><code>width</code> – Width of the code wrapper. Default is <code>100%</code>.</li>
<li><code>height</code> – Height of the code wrapper. Default is <code>100%</code>.</li>
</ul>
<p>eg: <code>[gist id = "12345" file = "myfile" width = "100%" height = "100%"]</code></p>
<h4>Embed Github files</h4>
<p>To embed a github file you have to use the following shortcode</p>
<pre><code>[github file = "{GITHUB_FILE}" start_line = "{START_LINE}" end_line = "{END_LINE}"]
</code></pre>
<ul>
<li><code>{GITHUB_FILE}</code> – full path to your github file. eg: If you want to embed https://github.com/sudar/MissileLauncher/blob/master/MissileLauncher.cpp then <code>{GITHUB_FILE}</code> would be /sudar/MissileLauncher/blob/master/MissileLauncher.cpp</li>
<li><code>{START_LINE}</code> – If you want to embed only part of the file, then you can specify the starting line number (optional)</li>
<li><code>{END_LINE}</code> – If you want to embed only part of the file, then you can specify the ending line number (optional)</li>
</ul>
<p>eg: <code>[github file = "/sudar/MissileLauncher/blob/master/MissileLauncher.cpp"]</code></p>
<p>if you want to embed only part of the file, then you can specify the start and end line as well</p>
<pre><code>[github file = "/sudar/MissileLauncher/blob/master/MissileLauncher.cpp" start_line = "10" end_line = "20"]
</code></pre>
<h3>Changing Gist-it server</h3>
<p>By default, this Plugin uses my own <a href="http://gist-it.sudarmuthu.com" rel="nofollow ugc">gist-it server</a> which is hosted on a free Google App Engine account. If you expect significant amount of traffic to your blog, then do consider using your own gist-it server. You can follow the <a href="http://sudarmuthu.com/wordpress/wp-github-gist/changing-gist-it-server" rel="nofollow ugc">instructions to deploy your own gist-it server</a> and then go to the settings page to change the url.</p>
<h3>Translation</h3>
<p>The pot file is available with the Plugin. If you are willing to do translation for the Plugin, use the pot file to create the .po files for your language and let me know. I will add it to the Plugin after giving credit to you.</p>
<h3>Support</h3>
<p>Support for the Plugin is available from the <a href="http://sudarmuthu.com/wordpress/wp-github-gist" rel="nofollow ugc">Plugin’s home page</a>. If you have any questions or suggestions, do leave a comment there or contact me in <a href="http://twitter.com/sudarmuthu" rel="nofollow ugc">twitter</a>.</p>
<h3>Readme Generator</h3>
<p>This Readme file was generated using <a href='http://sudarmuthu.com/wordpress/wp-readme' rel="nofollow ugc">wp-readme</a>, which generates readme files for WordPress Plugins.</p>


WP Github Gist

Unfortunately, this plugin does not seem to be working. If a solution is found, I'll bump my rating up to where it should be, as the basic idea is great.



Not working

Embed files and gist from Github in your blog posts or pages.

Gist GitHub Shortcode vs WP Github Gist