jekyll_include_plugin 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95de50df4d35189be9b48d90cb02b48b35a97f76b5774cf60880badd111d8d1
-  data.tar.gz: f1934737904c0ef858fb9c3c1aed41f959bceaeb552bd63aadc8f8ac7a8c7348
+  metadata.gz: 54bfb570062a4da31cc5867a42c04e27dbc9805fa5264e8c58e981767f0a278a
+  data.tar.gz: '09e7d4a74aed13c6b35989488f17f6585738a44040bdd67249d8adc63d692312'
 SHA512:
-  metadata.gz: fca8a82bc01e2743abf6ec1ea82569fb4e153fb90647f1eb3812a2cc0a93dff9cd4b98533f105a11e205a52d555ccd44107e12b91cdfd369353585a89e26fa28
-  data.tar.gz: 710a8474b3b34917edf60358ca8b9cbc90a14fd8f194dadd785e1ec027a12dc3f04b323c9bca07385c73d80b2393225b5608da81d108106bf90c0c42d5715470
+  metadata.gz: 6af90891514917916f37065d5478949692627bad43ab9155f2ff49dc564b9ff8feb3c9bf16de62732faa038292e553d84dfa9d39e87dbe8b19c65df414cefbbb
+  data.tar.gz: 21f27c73ba69245773207cf8ed917fb97b13b0fc34e57be8564ffa928ca3fc720525dfcabe73eb6c3587e4d77bf8b18a849130c51b0dead09356debc740d1c0e

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    jekyll_include_plugin (1.0.1)
-      jekyll (~> 3.9)
+    jekyll_include_plugin (1.1.0)
+      jekyll (>= 3.5, < 5.0)
       liquid (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     colorator (1.1.0)
     concurrent-ruby (1.1.9)
@@ -17,39 +17,45 @@ GEM
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     eventmachine (1.2.7)
+    eventmachine (1.2.7-x64-mingw32)
     ffi (1.15.3)
+    ffi (1.15.3-x64-mingw32)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
-    i18n (0.9.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.1)
+    jekyll (4.2.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (>= 1.17, < 3)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (~> 0.4.0)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (~> 3.0)
       safe_yaml (~> 1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     kramdown (2.3.1)
       rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     liquid (4.0.3)
-    listen (3.5.1)
+    listen (3.6.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
+    mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
-    rake (13.0.3)
+    rake (13.0.6)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -69,14 +75,17 @@ GEM
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
     safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc (2.4.0-x64-mingw32)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
+  x64-mingw32
 
 DEPENDENCIES
   jekyll_include_plugin!
@@ -84,4 +93,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.2.20

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll Include Plugin
 
-Include local/remote file contents (or part of it) into your pages.
+Include contents of local/remote plain text files (or parts of them) into your pages.
 Allows multilang comments in the included files, which language will be used depends on `{{ page.lang }}`.
 
 ## Usage
@@ -8,24 +8,24 @@ Allows multilang comments in the included files, which language will be used dep
 Basic usage as follows:
 
 ```jinja
-jekyllroot/pages/foo.md:
+/jekyllroot/pages/foo.md:
 -----------------------
 lang: en
 -----------------------
-{% include_file "this_dir_is_inside_jekyll_root_dir/foo/Dockerfile" snippet="system_deps" syntax="Dockerfile" %}
+{% include_file "foo/Dockerfile" snippet="system_deps" syntax="Dockerfile" %}
 ```
 
 ```Dockerfile
-this_dir_is_inside_jekyll_root_dir/foo/Dockerfile:
+/jekyllroot/foo/Dockerfile:
 --------------------------------------------------------
 FROM ruby
 
-# [<snippet install_system_deps>]
+# [<snippet system_deps>]
 # [<en>] Install system dependencies
 # [<en>] (multiline possible too)
 # [<ru>] Установка системных зависимостей
 RUN apt update && apt install curl -y
-# [<endsnippet install_system_deps>]
+# [<endsnippet system_deps>]
 ```
 
 Result:
@@ -35,19 +35,29 @@ Result:
 RUN apt update && apt install curl -y
 ```
 
-Include whole file:
+Include the local file (path is relative to Jekyll root):
 ```jinja
 {% include_file "Dockerfile" %}
 ```
 
-Include remote file:
+Include the remote file (only absolute urls):
 ```jinja
 {% include_file "https://raw.githubusercontent.com/werf/werf-guides/master/examples/rails/010_build/Dockerfile" %}
 ```
 
+Include part of the file (the part should be enclosed in `[<snippet snippetname>]` and `[<endsnippet snippetname>]`):
+```jinja
+{% include_file "Dockerfile" snippet="snippetname" %}
+```
+
+Include the file and wrap the result in `` ```dockerfile `` and `` ``` ``:
+```jinja
+{% include_file "Dockerfile" syntax="dockerfile" %}
+```
+
 Dynamic parameters:
 ```jinja
-{% include_file "{{ $templatingAllowedHere }}" snippet="{{ $hereToo }}" %}
+{% include_file "{{ $templatingAllowedHere }}/Dockerfile" snippet="{{ $hereToo }}" %}
 ```
 
 ## Installation

data/jekyll_include_plugin.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ilya Lesikov"]
   spec.email         = ["ilya@lesikov.com"]
 
-  spec.summary       = "Include files or file samples into Markdown, allows for multilang comments in included files."
+  spec.summary       = "Plugin for including contents of local/remote plain text files (or parts of them) into your pages. Allows for multilang comments in the included files."
   spec.homepage      = "https://github.com/flant/jekyll_include_plugin"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.6.3"
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "liquid", "~> 4.0"
-  spec.add_runtime_dependency "jekyll", "~> 3.9"
+  spec.add_runtime_dependency "jekyll", ">= 3.5", "< 5.0"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/jekyll_include_plugin/utils.rb

@@ -42,7 +42,8 @@ module JekyllIncludePlugin
       abort("End of the snippet '#{snippet_name}' has not been found.") unless snippet_end_found
       abort("Snippet '#{snippet_name}' appears to be empty. Fix and retry.") if snippet_content.empty?
 
-      return snippet_content
+      first_line_indent = %r!^\s*!.match(snippet_content)[0]
+      return "#{first_line_indent}...\n#{snippet_content}"
     end
 
     def remove_all_snippets(text)

data/lib/jekyll_include_plugin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllIncludePlugin
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_include_plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Ilya Lesikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -28,16 +28,22 @@ dependencies:
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +119,6 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Include files or file samples into Markdown, allows for multilang comments
-  in included files.
+summary: Plugin for including contents of local/remote plain text files (or parts
+  of them) into your pages. Allows for multilang comments in the included files.
 test_files: []