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 …
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:
master
The following document types are currently supported:
The following platforms are currently supported:
Note, this plugin uses Github’s wonderful /markdown
API to render to HTML. This comes with 2 caveats:
The plugin features a variety of shortcodes.
The document-specific shortcodes follow a pattern of [git-<platform>-<action>]
, where
<platform>
can be one of github
: if you use Github as your VCS platformbitbucket
: if you use Bitbucket as your VCS platformgitlab
: if you use Gitlab as your VCS platform<action>
can be one of markdown
: Render your Markdown files hosted on your VCS platform in Github’s rendering stylejupyter
: Render your Jupyter notebook hosted on your VCS platfrom (only for public repositories)checkout
: Renders a small badge-like box with a link to the document and the date of the last commithistory
: Renders a <h2>
section with the last commit dates, messages and authorsAdditionally, there’s an enclosing shortcode [git-add-css]
which adds a <div id="git-add-css" class="<classes_attribute>"
to wrap its contents. That way you can manipulate the style freely with additional CSS classes. Follow these steps:
class1
, class2
, class3
wp_enqueue_style('my-style', get_template_directory_uri().'/my-style.css');
to the theme’s functions.php
Add the enclosing git-add-css
shortcode to your post with the custom CSS classes in the classes
attribute, e.g.:
[git-add-css classes="class1 class2 class3"]
[git-gitlab-checkout url=...]
[git-gitlab-markdown url=...]
[git-gitlab-history url=...]
[/git-add-css]
Each shortcode takes a few attributes, indicating if it’s required for public or private repositories:
Attribute
Action
Public repo
Private repo
Type
Description
url
all except git-add-css
: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
user
all except git-add-css
:negative_squared_cross_mark:
:ballot_box_with_check:
string
The user name (not email) of an authorized user
token
all except git-add-css
:negative_squared_cross_mark:
:ballot_box_with_check:
string
The access token/app password for the authorized user
cache_ttl
all except git-add-css
:negative_squared_cross_mark:
:negative_squared_cross_mark:
integer
The time in seconds that the plugin will cache, only for cache_strategy=static
.
cache_strategy
all except git-add-css
:negative_squared_cross_mark:
:negative_squared_cross_mark:
integer
Only static
caching is implemented so far. dynamic
caching is on the way!
limit
history
:negative_squared_cross_mark:
:negative_squared_cross_mark:
integer
Limits the history of commits to this number. Default 5.
classes
git-add-css
:ballot_box_with_check:
:ballot_box_with_check:
string
The additional CSS classes to render the content with
Since most attributes will be the same across the entire system, this plugin offers the possibility to set all attributes globally except for url
:
In the menu Plugins ► Plugin Editor, choose “Documents from Git” and enter your preferences in the includes/config.json
.
Note, setting the attributes manually in the shortcode has always precedence over any settings in includes/config.json
.
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, static
and dynamic
which can be set via the cache_strategy
property.
Static caching (cache_strategy=static
)
This is the default strategy, as it doesn’t require any user action.
The property cache_ttl
sets how many seconds the content cache will keep alive.
Currently there’s no way to flush the cache manually. However, changing cache_ttl
or the history limit
will create a new cache.
Dynamic caching (cache_strategy=dynamic
)
This is not implemented yet. See #20 for details.
Token
authorizationYou need to authorize via user
and token
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 caching capabilities, it’s strongly recommended to register a Github access token regardless of the VCS hosting platform, see the beginning of the chapter.
How to generate the token
depends on your platform:
This plugin needs only Read access to your repositories. Keep that in mind when creating an access token.
We publish our own tutorials with this plugin: https://gis-ops.com/tutorials/.
[git-github-markdown 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" cache_ttl="3600" cache_strategy="static"]
[git-github-jupyter url="https://github.com/GIScience/openrouteservice-examples/blob/master/python/ortools_pubcrawl.ipynb"]
[git-bitbucket-jupyter user=nilsnolde token=3292_2p3a_84-2af url="https://bitbucket.org/nilsnolde/test-wp-plugin/src/master/README.md"]
[git-bitbucket-checkout url="https://bitbucket.org/nilsnolde/test-wp-plugin/src/master/README.md"]
git-gitlab-history limit=5 url="https://gitlab.com/nilsnolde/esy-osm-pbf/-/blob/master/README.md"]
The following example will put a dashed box around the whole post:
`
[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:
`css
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;
}
`
Directly from WordPress plugin repository.
Or the latest with WP Pusher:
Or install the latest code as ZIP from https://github.com/gis-ops/wordpress-markdown-git/archive/master.zip
Yes, since v2.0.0 the plugin has a subpage in the main Settings menu.
Yes, since v1.1.0 the plugin supports static caching of all relevant information. See the “Caching” section for details.
No, relative image links (e.g. ![img](./img.png)
) cannot be processed by this plugin. Please see the notes in the documentation for ways to work around this limitation.
Yes, you can, if you provide the plugin’s config.json
with the necessary credentials for your platform (see documentation for details). However, be aware that all image URLs you are referencing are openly accessible or provide the necessary authentication means. Also see #13 and the documentation for further details.
/markdown
requests