jekyll-plugin-include 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/.gitignore +1 -0
- data/CHANGELOG.md +14 -0
- data/README.md +14 -6
- data/lib/jekyll_plugin_include/version.rb +1 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f04ab44eeb134169b809a91054a8d408a8f4939e
|
|
4
|
+
data.tar.gz: e946359a6ba63964b45bd11449029ac34653a53b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ccf1c564a627239fa77ada4ded67691aa5b6036895aa52cb2561721e36da9e971df205f51dd51c267570432481d00cff28a29465935aa57af8f8e03af3110b44
|
|
7
|
+
data.tar.gz: 6ae8f1bcc9cbb45c5ea25671450e9d71f07f4911ad0cfc6a9c37f163c080d23ef453baf79284094b8ce9787dbd0de09eb06478ff8c25a439970399a7bf51b889
|
data/.gitignore
CHANGED
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
All notable changes to this project will be documented in this file.
|
|
3
|
+
|
|
4
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
## [0.1.1] - 2018.09.23
|
|
8
|
+
### Changed
|
|
9
|
+
* Make the liquid examples in the README not be wrong
|
|
10
|
+
* Expand README
|
|
11
|
+
|
|
12
|
+
## [0.1.0] - 2018.09.23
|
|
13
|
+
### Added
|
|
14
|
+
* All of the code. This is the first published commit.
|
data/README.md
CHANGED
|
@@ -28,7 +28,7 @@ group :jekyll_plugins do
|
|
|
28
28
|
end
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
## Jekyll `_config` install
|
|
31
|
+
## Jekyll `_config` install (not recommended)
|
|
32
32
|
|
|
33
33
|
Add it to the array `plugins` in your `_config.yml`:
|
|
34
34
|
```yaml
|
|
@@ -36,7 +36,7 @@ plugins:
|
|
|
36
36
|
- jekyll-plugin-include
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
## For use in your own gem-based plugin (gemspec)
|
|
40
40
|
|
|
41
41
|
Add something like this to your gemspec
|
|
42
42
|
```ruby
|
|
@@ -44,26 +44,34 @@ spec.add_runtime_dependency "jekyll-plugin-include", ">= 0.1.0"
|
|
|
44
44
|
```
|
|
45
45
|
# Usage
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
Syntax note: quotes are required for arguments with spaces, and whitespace after the `:` is acceptable
|
|
48
48
|
|
|
49
49
|
This plugin provides a single custom Jekyll Liquid tag which provides enhanced include-like functionality, so it will look a lot like the standard `include`.
|
|
50
50
|
|
|
51
51
|
In this example with the `jekyll-podcast` plugin, this will function much like Jekyll's normal `include` (inserting the rendered contents of `includefile.html`), but will look in the `_includes` directory of the specified plugin if it doesn't find the file in the site's configured includes directory.
|
|
52
52
|
|
|
53
53
|
```liquid
|
|
54
|
-
{% plugin_include
|
|
54
|
+
{% plugin_include _plugin:"jekyll-podcast" _file: "podcast_feed_episode_content_encoded.html" %}
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
It is also possible to *force* this plugin to skip the site's configured includes directory completely and look exclusively in the plugin's `_includes` directory with the `allow_override` parameter:
|
|
58
58
|
|
|
59
59
|
```liquid
|
|
60
|
-
{% plugin_include
|
|
60
|
+
{% plugin_include _plugin:"jekyll-podcast" _file: "podcast_feed_misc.xml" allow_override: false %}
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
## Include parameters
|
|
64
64
|
|
|
65
65
|
Any parameters passed to the include besides `_plugin` and `_file` will be passed through as-is and will be available as `include.param_name` in the file.
|
|
66
66
|
|
|
67
|
+
```liquid
|
|
68
|
+
{% plugin_include _plugin:"jekyll-podcast" _file: "podcast_feed_asset_path.html" assetpath:/assets/imgs/some_image.png %}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
# Github Pages
|
|
72
|
+
|
|
73
|
+
Github pages won't compile your custom ruby code, so you need to compile sites like this one elsewhere and then upload them to Github pages in their finished form. You can do this on your local machine, but also via services like [Travis CI](https://jekyllrb.com/docs/continuous-integration/travis-ci/).
|
|
74
|
+
|
|
67
75
|
# Testing
|
|
68
76
|
|
|
69
77
|
* syntax: a .rubocop.yml is provided. `rubocop lib/jekyll/plugin-include.rb`
|
|
@@ -78,4 +86,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
|
|
|
78
86
|
|
|
79
87
|
# Credits
|
|
80
88
|
|
|
81
|
-
By [Christopher Peterson](https://chrispeterson.info) for [Decipher Media](https://github.com/decipher-media/jekyll-plugin-include).
|
|
89
|
+
By [Christopher Peterson](https://chrispeterson.info) for [Decipher Media](https://github.com/decipher-media/jekyll-plugin-include) and based mostly on the [original code](https://github.com/jekyll/jekyll/blob/master/lib/jekyll/tags/include.rb) for the Jekyll include tag.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-plugin-include
|
|
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
|
- Decipher Media
|
|
@@ -104,6 +104,7 @@ files:
|
|
|
104
104
|
- ".rspec"
|
|
105
105
|
- ".rubocop.yml"
|
|
106
106
|
- ".travis.yml"
|
|
107
|
+
- CHANGELOG.md
|
|
107
108
|
- LICENSE.md
|
|
108
109
|
- README.md
|
|
109
110
|
- Rakefile
|