jekyll_github_content 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ddc3f0b418374cc40bb6a884a7e83b3446bcdf6
-  data.tar.gz: ec421a5b60fb89056d179c78ea5d7edd74e2767c
+SHA256:
+  metadata.gz: e054fa697438eb47fd5557e1ef516aefe226fbf2d0c4f4a05ea1a63a826525fd
+  data.tar.gz: 501b14a1e76bfd768986295b822df9b785dc8777387d4b344ede88670feb2b89
 SHA512:
-  metadata.gz: 6967e667c1a878d016242a6c06f4dbf3e6bd3b66ecb89c5ae392ad53a52ef410c43dc233ff8492ee574295ccfe09f61843c707e9e4eaec132f2622f3ba85705a
-  data.tar.gz: a84420ad01bf82fd62c99b48eaf32bdfdadf7828cf3905ceeb08975ab4ea54e178c891908cbedc0ccdc43088e6c6a3fc605d04120085698d32d4aa563d69276f
+  metadata.gz: 561d32c8dfdb3f218fa3efeafb2742adb4438369b6da575fd1469427653cc9f90deaef56fec93600aa2f979c16a9e7208d366762fab78c874b796f2fdb8f5261
+  data.tar.gz: e086404c04151e8e31adb83fa87c76bd1e42aa11f37bc5458c721d2fb2297d61b5e0a3fe8cde8981498c3b43a36e211eaca7580636d9a216ddeb7e9a29079675

data/README.md

@@ -1,8 +1,6 @@
-# JekyllGithubContent
+# Jekyll Github Content Gem
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/github/inserts`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby gem that allows to insert the content (or just a chunk) of Github files in [Jekyll](https://jekyllrb.com/).
 
 ## Installation
 
@@ -20,21 +18,40 @@ Or install it yourself as:
 
     $ gem install jekyll-github-content
 
+Additional instructions can be found in [here](https://rubygems.org/gems/jekyll_github_content/versions/0.0.3)
+
 ## Usage
 
-TODO: Write usage instructions here
+Insert the tags provided by the gem (`github_file` or `github_fileref`) in your Markdown files included in your Jekyll
+site. When Jekyll generates the site, it will read the tags with the help of the gem, which in turn uses [Liquid](https://shopify.github.io/liquid/)
+in order to present the results in the generated page.
+
+The required parameters for each tag are the following:
+
+1. github_file
+  * \<my_file_url_in_github\>
+  * [start_line] Optional
+  * [end_line] Optional
+2. github_fileref
+  * \<my_file_url_in_github\>
+
+Examples:
+* {% github_file \<my_file_url_in_github\> [start_line] [end_line] %}
+* {% github_fileref \<my_file_url_in_github\> %}
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `jekyll_github_content.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-github-content.
+Bug reports and pull requests are welcome on GitHub at https://github.com/francisco-perez-sorrosal/jekyll-github-content.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/jekyll_github_content.rb

@@ -45,7 +45,7 @@ module JekyllGithubContent
 
     def render(context)
       file_lines = cache.fetch(@github_file.get_raw_file_uri) do
-        open(@github_file.get_raw_file_uri).readlines
+        URI.open(@github_file.get_raw_file_uri).readlines
       end
       lines_to_print = file_lines[@initial_line..@end_line]
       lines_to_print.join

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_github_content
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Francisco Perez-Sorrosal
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
 date: 2016-08-15 00:00:00.000000000 Z
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.a
+        version: 2.5.23
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.a
+        version: 2.5.23
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
 description: Allows to insert github files in jekyll markdown files
 email:
 - fperezsorrosal@gmail.com
@@ -82,7 +82,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: Insert github files with jekyll
 test_files: []