Markdown Github

Description

WordPress Plugin to use Github as collaboration and version control platform for Markdown documents.

Advantages:

  • Easy to update by external users via pull requests, minimizes the chance of stale tutorials
  • Write Markdown in your favorite editor and just push to your repo to update your blog

It features 3 shortcodes:

  1. [md_github token=YourToken url=Github URL]: Pulls raw HTML from the https://api.github.com/repos/ endpoint and styles it with Github markdown CSS
  2. [checkout_github token=YourToken url=Github URL]: Displays a formatted link to the repo with the date of the latest update
  3. [history_github token=YourToken url=Github URL]: Displays a commit history of the last 5 commits.

Github API is queried on every new load of the page, so that changes in the repository will immediately be reflected on your blog. Private authentication tokens help increasing the API limit to 5000 requests per hour (enough even for Digital Ocean blogs) and accessing private repositories.

Idea and most of the code is based on Andy Challis’ WP plugin to display Jupyter notebooks https://github.com/ghandic/nbconvert. The CSS is taken from https://github.com/sindresorhus/github-markdown-css.

Usage

All shortcodes take token and url as attribute. token is your private personal access token, which you can generate here. url is the full URL to your document on Github. E.g.

[md_github token=1d6ef5ba426648ef7d2273aca2fc80787 url=https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_PluginBasics.md]

[checkout_github token=1d6ef5ba426648ef7d2273aca2fc80787 url=https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_PluginBasics.md]

[history_github token=1d6ef5ba426648ef7d2273aca2fc80787 url=https://github.com/gis-ops/tutorials/blob/master/qgis/QGIS_PluginBasics.md]<h3>Demo</h3>

Check it out on of our blogs:

https://gis-ops.com/react-redux-leaflet-turfjs-building-a-density-based-clustering-dbscan-app-with-the-almighty-here-maps-places-api/

Support

Add issues at https://github.com/gis-ops/md-github-wordpress/issues.

Installation

  1. Install WP Pusher (https://wppusher.com) via ZIP and activate
  2. Install from Github via WP Pusher from gis-ops/md-github-wordpress
  3. Activate and add shortcode to your posts.

Or directly from WordPress plugin repository.

Or install as ZIP from https://github.com/gis-ops/md-github-wordpress/archive/master.zip

Reviews

June 6, 2019
너무좋은 플러그인이에요 잘활용하고있습니다. 이 플러그인덕분에 포스트 관리는 모두 깃헙으로 하고있습니다.
March 20, 2019
This plugin lets you take out all your posts out of WordPress and store them in Github as Markdown files. This plugin essentially bridges the gap between WordPress and static site generators like Jekyll, Hugo,...etc. As a result all your content is version controlled in standard Github. How cool is that!!!
Read all 2 reviews

Contributors & Developers

“Markdown Github” is open source software. The following people have contributed to this plugin.

Translate “Markdown Github” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

v1.1.0

  • Add shortcode to display commit history

v1.0.0

  • First version