jekyll-readme-index 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9bc7c506d7f680ea917ae338e110518bdb8078a
+  data.tar.gz: f5ae60ee147bc8cf4f8dae4c4d372ed740a015b0
+SHA512:
+  metadata.gz: 4cf1e81d7e4a64e7d925969a23b70d68b24f7832196f66df907edbad761d68a812d1656da500a575c0c8ad988f1d43e6c11b04c2ab5e42786f8819536c1428f4
+  data.tar.gz: d1da4e793a76ef533bd929c43395e4f2e7b062b1b3c110dc7cec47bba231805caadfa261ad144159b4e19801e5c9e5a1e9af834d8c0c880a8ca4ef647d973c55

data/lib/jekyll-readme-index.rb

@@ -0,0 +1,5 @@
+require "jekyll"
+
+module JekyllReadmeIndex
+  autoload :Generator, "jekyll-readme-index/generator"
+end

data/lib/jekyll-readme-index/generator.rb

@@ -0,0 +1,42 @@
+module JekyllReadmeIndex
+  class Generator < Jekyll::Generator
+    README_REGEX = %r!^/readme(\.[^.]+)?$!i
+    INDEX_REGEX = %r!^/index.html?$!i
+
+    attr_accessor :site
+
+    safe true
+    priority :low
+
+    def initialize(site)
+      @site = site
+    end
+
+    def generate(site)
+      @site = site
+
+      return if index? || readme.nil?
+      site.pages << page
+    end
+
+    private
+
+    def readme
+      site.static_files.find { |file| file.relative_path =~ README_REGEX }
+    end
+
+    def index?
+      site.pages.any? { |page| page.url == "/" } ||
+        site.static_files.any? { |file| file.url =~ INDEX_REGEX }
+    end
+
+    def page
+      base = readme.instance_variable_get("@base")
+      dir  = readme.instance_variable_get("@dir")
+      name = readme.instance_variable_get("@name")
+      page = Jekyll::Page.new(site, base, dir, name)
+      page.data["permalink"] = "/"
+      page
+    end
+  end
+end

data/lib/jekyll-readme-index/version.rb

@@ -0,0 +1,3 @@
+module JekyllReadmeIndex
+  VERSION = "0.0.1".freeze
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-readme-index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+description: 
+email:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-readme-index.rb
+- lib/jekyll-readme-index/generator.rb
+- lib/jekyll-readme-index/version.rb
+homepage: https://github.com/benbalter/jekyll-readme-index
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to render a project's README as the site's index.
+test_files: []