Embed GitHub Gist

Description

This project is available for forking on GitHub:

• https://github.com/dflydev/embed-github-gist

Embed GitHub Gists into
WordPress. Provides a shortcode for posts and pages but also has the ability
to embed by hand in the event that a Gist needs to be embedded somewhere in
the page that does not pass through the shortcode filters.

Examples:

[gist id=546764]
[gist id=546764 file=file.txt]
[gist id=546764 file=file.txt bump=1]
[gist]https://gist.github.com/546764[/gist]

Cache is implemented with the Transients API to minimize delay on loading
content. Default TTL (time to live) is 86400 seconds or one day.

Upcoming features:

• Option for setting default TTL
• Option to bypass cache entirely
• Implement admin interface to control options

Installation

1. Download the plugin zip file
2. Unzip contents of plugin zip file
3. Upload the embed-github-gist directory to the /wp-content/plugins/ directory
4. Activate the plugin through the ‘Plugins’ menu in WordPress
5. Start using the plugin by adding Gists to posts!

FAQ

How can I fix rate limit exceded errors?

Define EMBED_GISTHUB_USERNAME and EMBED_GISTHUB_PASSWORD in wp-settings.php.

Can the cache be broken?

Yes. Use a unique bump value to force cache to update. For instance, if you have
the following:

[gist id=546764]

The cache can be broken by specifying a bump value:

[gist id=546764 bump=1]

To break the cache again later, change to a new unique bump value:

[gist id=546764 bump=2]

Can I change the TTL on a Gist-by-Gist basis?

Yes. Specify a TTL (in seconds) like this:

[gist id=546764 ttl=3600]

Can I embed a Gist outside of a post or a page?

Yes.

<?php echo embed_github_gist(546764); ?>

Can I display a specific file from my gist?

Ues. You can use the file parameter:

[gist id=546764 file=file.txt]

Reviews

Contributors & Developers

Changelog

0.13

• Looks at EMBED_GISTHUB_USERNAME and EMBED_GISTHUB_PASSWORD for API requests

0.12

• Bump release (“same as 0.11”)
• Added upgrade notes

0.11

• Updated to account for recent changes to Gist.

0.10

• Bump release (“same as 0.9”)

0.9

• Fix js link bug. Thanks to wrightlabs.

0.8

• Better handle SSL errors. Thanks to gabesumner and CaioProiete.

0.7

• Edit to also include $file in cache key (thanks https://github.com/troufster)

0.6

• Embed stylesheet is now cached locally by default
• Fixed small file-bug when using json

0.5

• Updates from oncletom (change default settings, works with new HTTPS URL from Gist)

0.4

• Bump release (“same as 0.2”)

0.3

• Bump release (“same as 0.2”)

0.2

• Added to support passing a Gist URL as the content of the [gist] shortcode.

0.1

• First release.