jekyll_github_sample 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -5
- data/jekyll_github_sample.gemspec +3 -3
- data/lib/jekyll_github_sample/version.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5585bb2ea60e1388df57d874f086433b379a1aee
|
4
|
+
data.tar.gz: 9673372519de8950efe55069e0e891a2238b5865
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6b32f27b4fb16cb00ea9255d41ceee949b88cfc79ac564b4fc939b7589d8439c1641d1989301d9eec61af4abaab6ea32b25fc0126f283b1e714fff5e258dca9b
|
7
|
+
data.tar.gz: dbf67abb90d396482697b641a14818e16b3579c987351e63c338b9ee4a8e1193043eace9592c83c1f02c5a7d5551d23bee503ed7535075d34d47f50b3796a2c1
|
data/README.md
CHANGED
@@ -5,7 +5,17 @@ Two Jekyll Liquid tags to display a code sample from a file in a public Github r
|
|
5
5
|
|
6
6
|
# Install
|
7
7
|
|
8
|
-
|
8
|
+
- First add the gem to your `Gemfile`
|
9
|
+
```
|
10
|
+
gem 'jekyll_github_sample'
|
11
|
+
```
|
12
|
+
- `bundle` to install the gem
|
13
|
+
- Add the gem to your Jekyll `_config.yml`
|
14
|
+
|
15
|
+
```
|
16
|
+
gems: [jekyll_github_sample]
|
17
|
+
```
|
18
|
+
- Startup or relaunch Jekyll
|
9
19
|
|
10
20
|
# Live Examples
|
11
21
|
|
@@ -13,19 +23,19 @@ A [write up](https://bwillis.github.io/2014/05/28/include-github-repo-code-in-je
|
|
13
23
|
|
14
24
|
# github_sample Usage
|
15
25
|
```
|
16
|
-
github_sample URL_WITH_USERNAME_REPO_AND_FILE <START_LINE_NUMBER> <END_LINE_NUMBER>
|
26
|
+
{% github_sample URL_WITH_USERNAME_REPO_AND_FILE <START_LINE_NUMBER> <END_LINE_NUMBER> %}
|
17
27
|
```
|
18
28
|
|
19
|
-
* URL_WITH_USERNAME_REPO_AND_FILE - the
|
29
|
+
* URL_WITH_USERNAME_REPO_AND_FILE - the relative path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs. A url to this README would be: `bwillis/jekyll-github-sample/blob/a3bc9e82412d364aa76e9308ab53ff2bddaa2faf/README.md`
|
20
30
|
* START_LINE_NUMBER - (optional) number that is the first line to include (0 based)
|
21
31
|
* END_LINE_NUMBER - (optional) number that is the last line to include, if excluded will read to end of file
|
22
32
|
|
23
|
-
#
|
33
|
+
# github_sample_ref Usage
|
24
34
|
```
|
25
35
|
{% github_sample_ref URL_WITH_USERNAME_REPO_AND_FILE %}
|
26
36
|
```
|
27
37
|
|
28
|
-
* URL_WITH_USERNAME_REPO_AND_FILE - the
|
38
|
+
* URL_WITH_USERNAME_REPO_AND_FILE - the relative path to the Github repo file, prefer a file with the commitish in it so it won't change when recompiling occurs. A url to this README would be: `bwillis/jekyll-github-sample/blob/a3bc9e82412d364aa76e9308ab53ff2bddaa2faf/README.md`
|
29
39
|
|
30
40
|
# Example Usage
|
31
41
|
|
@@ -37,3 +47,12 @@ This is how you would display, reference and highlight code in your Jekyll post.
|
|
37
47
|
{% github_sample /bwillis/versioncake/989237901cb873f96df12be48cbf1239be496bd7/Appraisals 0 5 %}
|
38
48
|
{% endhighlight %}
|
39
49
|
```
|
50
|
+
|
51
|
+
# Thanks!
|
52
|
+
|
53
|
+
Thanks to all those who have helped make this really awesome:
|
54
|
+
|
55
|
+
* [heedfull](https://github.com/heedfull)
|
56
|
+
|
57
|
+
# License
|
58
|
+
Jekyll Github Sample is released under the MIT license: www.opensource.org/licenses/MIT
|
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
|
|
8
8
|
s.license = 'MIT'
|
9
9
|
s.authors = ['Ben Willis']
|
10
10
|
s.email = ['benjamin.willis@gmail.com']
|
11
|
-
s.homepage = '
|
11
|
+
s.homepage = 'https://github.com/bwillis/jekyll-github-sample'
|
12
12
|
s.summary = %q{Include a sample of a Github repo file.}
|
13
13
|
s.description = %q{Easily reference and include a Github repo file in your post.}
|
14
14
|
|
@@ -17,10 +17,10 @@ Gem::Specification.new do |s|
|
|
17
17
|
s.require_paths = ['lib']
|
18
18
|
|
19
19
|
s.add_dependency 'activesupport', '~> 4.0'
|
20
|
-
s.add_dependency 'jekyll', '~>
|
20
|
+
s.add_dependency 'jekyll', '~> 2.0'
|
21
21
|
|
22
22
|
s.add_development_dependency 'rspec'
|
23
23
|
s.add_development_dependency 'bundler'
|
24
24
|
s.add_development_dependency 'rake'
|
25
25
|
|
26
|
-
end
|
26
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll_github_sample
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ben Willis
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-
|
11
|
+
date: 2014-07-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -30,14 +30,14 @@ dependencies:
|
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: '
|
33
|
+
version: '2.0'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '2.0'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: rspec
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -102,7 +102,7 @@ files:
|
|
102
102
|
- spec/lib/jekyll_github_sample/file_helper_spec.rb
|
103
103
|
- spec/lib/jekyll_github_sample/text_utils_spec.rb
|
104
104
|
- spec/spec_helper.rb
|
105
|
-
homepage:
|
105
|
+
homepage: https://github.com/bwillis/jekyll-github-sample
|
106
106
|
licenses:
|
107
107
|
- MIT
|
108
108
|
metadata: {}
|