WP GitHub Code Viewer

WP GitHub Code Viewer

GitHub Code Viewer 2 is a plugin for wordpress that will automatically pull a file from github and place into any post using a shortcode [github_cv url='$url']. It caches the code locally (in db), so it’s quite fast and can be even faster when combined with wp_super_cache or w3c_total_cache. It will re-request the code from github every 24 hours (by default, but it’s configurable) so the code in your post will always remain up to date. It is a heavily modified version of the original GitHub Code Viewer plugin written by Matt Curry (http://www.pseudocoder.com).

Installation

  1. Upload `GitHub_Code_Viewer.php` to the `/wp-content/plugins/` directory (or install through the ‘add new’ functionality in wordpress)
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Use the shortcode [github_cv url='<URL TO FILE ON GITHUB>'] in your post.

Usage

  1. Find a given file on github you want to include in a blog post / page.
  2. Grab the url to this page, eg..
  3. Place this code in your post [github_cv url='<THE URL>'] where you want the file to appear.
  4. Optionally provide a different TTL (time to live), default is ’1 day’. This will be passed to str_to_time, so pass in whatever it would accept. This would look like:
    [github_cv url='<URL>' ttl='1 week']
  5. Optionally surround the code with a syntax highlighter. ColorCoder is a good one which uses the geshi library.

Example

[github_cv url='https://github.com/spf13/wp_GitHub_Code_Viewer/blob/master/GitHub_Code_Viewer.php']

[github_cv url='https://github.com/spf13/wp_GitHub_Code_Viewer/blob/master/GitHub_Code_Viewer.php']

Fork me on GitHub

  • Pingback: Tweets that mention WP GitHub Code Viewer | Steve Francia's Blog -- Topsy.com

  • http://twitter.com/BoweFrankema Bowe Frankema

    Really cool plugin! Might be very useful for an upcoming project I’m working on.. I was wondering; Is there a way to include only a fraction (snippet) from a file instead of the entire file?

    For instance if you want to write documentation and want to show a certain snippet from a file instead of displaying the entire file.

    Good work :)

  • Anonymous

    Thanks, glad you are enjoying it. There isn’t yet, but I don’t think it would be very hard to write, I’ll try to add that when I have time or feel free to fork it on github and add it and I’ll pull in your updates.

  • Anonymous

    Thank you for the wonderful plugin.

  • http://twitter.com/julioterra Julio Terra

    Steve, thanks a lot for writing this plugin. Unfortunately, I had an issue activating this plugin on my wordpress blog. I’m posting the details on git hub. I would try to fix it myself but I don’t have the php chops. Thought I would let you know in case you plan to work on this project more in the future.