-
Notifications
You must be signed in to change notification settings - Fork 29
/
readme.txt
155 lines (99 loc) · 3.42 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
=== Embed GitHub Gist ===
Contributors: dflydev
Tags: github, gist, source, syntax, highlight, highlighter, embed
Requires at least: 2.8.6
Tested up to: 3.5
Stable tag: 0.13
Embed GitHub Gists into WordPress.
== Description ==
This project is available for forking on GitHub:
* https://github.com/dflydev/embed-github-gist
Embed [GitHub](http://github.com/) [Gists](http://gist.github.com) 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]http://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
1. Unzip contents of plugin zip file
1. Upload the embed-github-gist directory to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
1. Start using the plugin by adding Gists to posts!
== Frequently Asked Questions ==
= 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]`
== Screenshots ==
No screenshots now!
== 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.
== Upgrade Notice ==
= 0.13 =
Now looks for EMBED_GISTHUB_USERNAME and EMBED_GISTHUB_PASSWORD
= 0.12 =
= 0.11 =
Now defaults to not embedding HTML directly.
Now requires json_decode to be available.
= 0.5 =
Now defaults to using cache and embedding HTML directly.
= 0.4 =
No changes from previous release.
= 0.3 =
No changes from previous release.
= 0.2 =
Should have no negative impact.
= 0.1 =
First release.