dergachev / redmine_gist

Redmine plugin adding a {{gist}} macro that embeds Github Gists into Redmine.

Gist Embed Redmine Plugin

Redmine plugin adding a {{gist}} macro that embeds Github Gists into Redmine.

Usage

Redmine plugin adding a {{gist}} macro that embeds Github Gists into Redmine.

To embed the public gist https://gist.github.com/4033291 : {{gist(4033291)}}

You can embed a specific file from a gist: {{gist(4033291,README.md)}}

Private gists work too: {{gist(28c72d38da181f38bbb9)}}

You can also just paste in the gist URL: {{gist(https://gist.github.com/4033291)}}

Be careful about using the URL syntax when embedding specific files. If the filename has any capital letters (eg "README.md"), the permalink gist generates will downcase the filename (eg "https://gist.github.com/4033291#file_readme.md"), preventing the plugin from extracting the original filename and breaking the embedding. Instead, provide the filename as second argument: {{gist(https://gist.github.com/4033291,README.md)}}

Installation

1. cd PATH_TO_REDMINE/vendor/plugins
2. git clone git://github.com/dergachev/redmine_gist.git gist
3. (restart Redmine web server)

More info

If you'd like to have a wiki page documenting this plugin, see USAGE.textile.

Notes

Tested on Redmine 1.3, though hopefully compatible with future versions too.

License

This plugin is licensed under the GNU GPL v2. See LICENSE.txt for details.

redmine_gist's Issues

Broken when embedding gists with username

{{gist(https://gist.github.com/dergachev/f484fb3cf479e5fab776)}}

errors out: 404 for dergachev.js

clearly should be loading f484fb3cf479e5fab776.js instead

This works though:

{{gist(https://gist.github.com/f484fb3cf479e5fab776)}}

Consider downloading and inlining HTML

The equivalent wordpress plugin offers an option to have Wordpress store the HTML code from gist, so each view doesn't need to hit the gist server. See: https://github.com/dflydev/embed-github-gist/blob/master/embed-github-gist.php

Gists contents dont appear in redmine search

Obviously with the approach of JS embedding redmine search will not pickup gist contents.
So not an ideal solution until this is resolved somehow, perhaps by using Gist API to download the contents and stick them into the search index somehow.

I think the wordpress plugin does something relevant:
https://github.com/dflydev/embed-github-gist/blob/master/embed-github-gist.php

README.md is not rendered as markdown in embedded gists

{{gist(https://gist.github.com/4165548)}}

result:

Other people seem to notice it too: http://stackoverflow.com/questions/11456558/markdown-not-rendered-in-embedded-gist

I'd imagine that an obvious workaround would be to also add a JS markdown renderer, like Showdown. See:

• http://www.showdown.im/
• http://stackoverflow.com/questions/1319657/javascript-to-convert-markdown-textile-to-html-and-ideally-back-to-markdown-t
• http://mathiasbynens.be/notes/showdown-javascript-jquery

Improve URL syntax for specific file

Currently the readme has a big warning about how the plugin can't reliably extract filenames from URLs such as https://gist.github.com/1353700#file_readme.md due to lowercasing, etc.

One idea for a workaround: use the gist API (now supports JSONP) to do the embedding manually. Or if not manually, then just to extract the original filename (inefficient!).
Here's an example:

https://gist.github.com/4033291.json (consider using http://jsonprettyprint.com/)
https://api.github.com/gists/4033291
https://api.github.com/gists/4033291/files

More info: http://stackoverflow.com/questions/4741520/how-can-i-embed-an-entire-github-gist-dynamically-on-a-page