Jason Stallings

Github Shortcode is a plugin that allows you to embed a GitHub repository in a page or post using a simple shortcode.
Usage:
[github repo=”octalmage/Github-Shortcode”]

Github Shortcode

Easily display GitHub Repositories in Pages/Posts.

nilsnolde

Danilo Pinotti

Official documentation: https://github.com/gis-ops/wordpress-markdown-git
This WordPress Plugin lets you easily publish, collaborate on and version control your [Markdown, Jupyter notebook] documents directly from your favorite remote Git platform, even if it’s self-hosted.
The advantages are:
<ul>
<li>Write documents in your favorite editor and just push to your remote repository to update your blog instantly</li>
<li>Use the power of version control: publish different versions of the document in different posts, i.e. from another branch or commit than latest <code>master</code></li>
<li>Easy to update by your readers via pull requests, minimizing the chance of stale tutorials</li>
</ul>
The following document types are currently supported:
<ul>
<li>Markdown</li>
<li>Jupyter notebooks (only for public repositories)</li>
</ul>
The following platforms are currently supported:
<ul>
<li>Github</li>
<li>Bitbucket</li>
<li>Gitlab</li>
</ul>
<h3>Usage</h3>
Note, this plugin uses Github’s wonderful <a href="https://developer.github.com/v3/markdown/" rel="nofollow ugc"><code>/markdown</code> API</a> to render to HTML. This comes with 2 caveats:
<ol>
<li>Unless authenticated, the rate limit is set at 60 requests per minute. Since v1.1.0 the plugin is capable of statically <a href="#caching" rel="nofollow ugc">caching content</a>. In case that’s not dynamic enough for you, your only option currently is to not use any cache in which case every document will be pulled from your provider every time someone opens it on your site. Then it’s strongly recommended to create a Github access token and register it with the plugin. Then the rate limit will be set to 5000 requests per hour. See <a href="#global-attributes" rel="nofollow ugc">Global attributes section</a> for details on how to do that.</li>
<li>The Markdown content cannot exceed 400 KB, so roughly 400 000 characters incl whitespace. If not a monographic dissertation, this should not be an applicable limit though.</li>
</ol>
<h3>Shortcodes</h3>
The plugin features a variety of shortcodes.
<h4>Publish documents</h4>
The document-specific shortcodes follow a pattern of <code>[git-<platform>-<action>]</code>, where
<ul>
<li><code><platform></code> can be one of
<ul>
<li><code>github</code>: if you use Github as your VCS platform</li>
<li><code>bitbucket</code>: if you use Bitbucket as your VCS platform</li>
<li><code>gitlab</code>: if you use Gitlab as your VCS platform</li>
</ul>
</li>
<li><code><action></code> can be one of
<ul>
<li><code>markdown</code>: Render your Markdown files hosted on your VCS platform in Github’s rendering style</li>
<li><code>jupyter</code>: Render your Jupyter notebook hosted on your VCS platfrom (only for public repositories)</li>
<li><code>checkout</code>: Renders a small badge-like box with a link to the document and the date of the last commit</li>
<li><code>history</code>: Renders a <code><h2></code> section with the last commit dates, messages and authors</li>
</ul>
</li>
</ul>
<h4>Manipulate rendering style</h4>
Additionally, there’s an enclosing shortcode <code>[git-add-css]</code> which adds a <code><div id="git-add-css" class="<classes_attribute>"</code> to wrap its contents. That way you can manipulate the style freely with additional CSS classes. Follow these steps:
<ol>
<li>Add a CSS file to your theme’s root folder, which contains some classes, e.g. <code>class1</code>, <code>class2</code>, <code>class3</code></li>
<li>Enqueue the CSS file by adding <code>wp_enqueue_style('my-style', get_template_directory_uri().'/my-style.css');</code> to the theme’s <code>functions.php</code></li>
<li>
Add the enclosing <code>git-add-css</code> shortcode to your post with the custom CSS classes in the <code>classes</code> attribute, e.g.:
<code>[git-add-css classes="class1 class2 class3"] 
[git-gitlab-checkout url=...] 
[git-gitlab-markdown url=...] 
[git-gitlab-history url=...] 
[/git-add-css]</code>
</li>
</ol>
<h3>Attributes</h3>
Each shortcode takes a few attributes, indicating if it’s required for public or private repositories:
 Attribute 
 Action 
 Public repo 
 Private repo 
 Type 
 Description
 <code>url</code> 
 all except <code>git-add-css</code> 
 :ballot_box_with_check: 
 :ballot_box_with_check: 
 string 
 The browser URL of the document, e.g. https://github.com/gis-ops/wordpress-markdown-git/blob/master/README.md
 <code>user</code> 
 all except <code>git-add-css</code> 
 :negative_squared_cross_mark: 
 :ballot_box_with_check: 
 string 
 The user name (not email) of an authorized user
 <code>token</code> 
 all except <code>git-add-css</code> 
 :negative_squared_cross_mark: 
 :ballot_box_with_check: 
 string 
 The access token/app password for the authorized user
 <code>cache_ttl</code> 
 all except <code>git-add-css</code> 
 :negative_squared_cross_mark: 
 :negative_squared_cross_mark: 
 integer 
 The time in seconds that the plugin will cache, only for <code>cache_strategy=static</code>.
 <code>cache_strategy</code> 
 all except <code>git-add-css</code> 
 :negative_squared_cross_mark: 
 :negative_squared_cross_mark: 
 integer 
 Only <code>static</code> caching is implemented so far. <code>dynamic</code> caching is on the way!
 <code>limit</code> 
 <code>history</code> 
 :negative_squared_cross_mark: 
 :negative_squared_cross_mark: 
 integer 
 Limits the history of commits to this number. Default 5.
 <code>classes</code> 
 <code>git-add-css</code> 
 :ballot_box_with_check: 
 :ballot_box_with_check: 
 string 
 The additional CSS classes to render the content with
<h4>Global attributes</h4>
Since most attributes will be the same across the entire system, this plugin offers the possibility to set all attributes globally except for <code>url</code>:
In the menu Plugins ► Plugin Editor, choose “Documents from Git” and enter your preferences in the <code>includes/config.json</code>.
Note, setting the attributes manually in the shortcode has always precedence over any settings in <code>includes/config.json</code>.
<h4>Caching</h4>
Often we need to prioritize speed when loading content and, in addition, it is very costly to fetch, load and format the content every time we need to read the content of the post.
This plugin soon offers 2 methods for caching, <code>static</code> and <code>dynamic</code> which can be set via the <code>cache_strategy</code> property.
Static caching (<code>cache_strategy=static</code>)
This is the default strategy, as it doesn’t require any user action.
The property <code>cache_ttl</code> sets how many seconds the content cache will keep alive.
Currently there’s no way to flush the cache manually. However, changing <code>cache_ttl</code> or the history <code>limit</code> will create a new cache.
Dynamic caching (<code>cache_strategy=dynamic</code>)
This is not implemented yet. See <a href="https://github.com/gis-ops/wordpress-markdown-git/issues/20" rel="nofollow ugc">#20</a> for details.
<h4><code>Token</code> authorization</h4>
You need to authorize via <code>user</code> and <code>token</code> if you intend to publish from a private repository. You don’t need to authorize if the repository is open.
However, keep in mind that some platforms have stricter API limits for anonymous requests which are greatly extended if you provide your credentials. So even for public repos it could make sense. And unless you use this plugin’s <a href="#caching" rel="nofollow ugc">caching capabilities</a>, it’s strongly recommended to register a Github access token regardless of the VCS hosting platform, see the <a href="#usage" rel="nofollow ugc">beginning of the chapter</a>.
How to generate the <code>token</code> depends on your platform:
<ul>
<li>Github: Generate a Personal Access Token following <a href="https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line" rel="nofollow ugc">these instructions</a></li>
<li>Bitbucket: Generate a App Password following <a href="https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html#Apppasswords-Createanapppassword" rel="nofollow ugc">these instructions</a></li>
<li>Gitlab: Generate a Personal Access Token following <a href="https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token" rel="nofollow ugc">these instructions</a></li>
</ul>
This plugin needs only Read access to your repositories. Keep that in mind when creating an access token.
<h3>Examples</h3>
We publish our own tutorials with this plugin: https://gis-ops.com/tutorials/.
<h4>Publish Markdown from Github</h4>
<pre><code>[git-github-markdown url="https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_SimplePlugin.md"]
</code></pre>
<h4>Publish Markdown from Github with 1 hour cache</h4>
<pre><code>[git-github-markdown url="https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_SimplePlugin.md" cache_ttl="3600" cache_strategy="static"]
</code></pre>
<h4>Publish Jupyter notebook from Github</h4>
<pre><code>[git-github-jupyter url="https://github.com/GIScience/openrouteservice-examples/blob/master/python/ortools_pubcrawl.ipynb"]
</code></pre>
<h4>Publish from a private repository</h4>
<pre><code>[git-bitbucket-jupyter user=nilsnolde token=3292_2p3a_84-2af url="https://bitbucket.org/nilsnolde/test-wp-plugin/src/master/README.md"]
</code></pre>
<h4>Display last commit and document URL from Bitbucket</h4>
<pre><code>[git-bitbucket-checkout url="https://bitbucket.org/nilsnolde/test-wp-plugin/src/master/README.md"]
</code></pre>
<h4>Display commit history from Gitlab</h4>
<pre><code>git-gitlab-history limit=5 url="https://gitlab.com/nilsnolde/esy-osm-pbf/-/blob/master/README.md"]
</code></pre>
<h4>Use additional CSS classes to style</h4>
The following example will put a dashed box around the whole post:
<pre><code>`
</code></pre>
[git-add-css classes=”md-dashedbox”] 
 [git-github-checkout url=”https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_SimplePlugin.md”] 
 [git-github-markdown url=”https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_SimplePlugin.md”] 
 [git-github-history url=”https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_SimplePlugin.md”] 
[/git-add-css] 
 `
With the following CSS file contents enqueued to your theme:
<pre><code>`css
</code></pre>
div.md_dashedbox { 
 position: relative; 
 font-size: 0.75em; 
 border: 3px dashed; 
 padding: 10px; 
 margin-bottom:15px 
}
div.md_dashedbox div.markdown-github { 
 color:white; 
 line-height: 20px; 
 padding: 0px 5px; 
 position: absolute; 
 background-color: #345; 
 top: -3px; 
 left: -3px; 
 text-transform:none; 
 font-size:1em; 
 font-family: “Helvetica Neue”,Helvetica,Arial,sans-serif; 
} 
 `

Documents from Git

With this plugin I can centralize my post reviews at github without further efforts

Very useful plugin

A plugin to inject and render files in a WordPress post or page directly from most popular Git platforms. Currently supported file types: Markdown, J …

Github Shortcode vs Documents from Git