jekyll-info 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 459123013f2b1c645322b858697396e317b1e6f2
+  data.tar.gz: e2d49d5313ad2331729f290be90869eae8062488
+SHA512:
+  metadata.gz: 0c2694465d022fb5dffd3f0b5eaad8940200c61036279a313983fd9ea68cff0fa8d18b253a3f947ec354d7007e11e4e1a607e88cb4a1859be68b1eb6c4ea0c39
+  data.tar.gz: 35537c5ead4eaed6c40038cf1fc21d25df43e51a4cc4e548fbdb6bd783b8c94adb17a408f1dd045719ee1bed71640475c591772b5e73c35ac331c3c8fd2313c4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Steven Westmoreland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# Jekyll Info plugin
+
+A Jekyll plugin to provide information about your Jekyll site
+
+## Installation
+
+Add this line to your site's Gemfile:
+
+```ruby
+gem 'jekyll-info'
+```
+
+And then add this line to your site's `_config.yml`:
+
+```yml
+plugins:
+  - jekyll-info
+```
+
+## Usage
+
+The plugin will automatically generate a page at `/jekyll-info.html`.

data/jekyll-info.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-info/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-info"
+  spec.version       = Jekyll::Info::VERSION
+  spec.authors       = ["Steven Westmoreland"]
+  spec.email         = ["steven.westmoreland@gmail.com"]
+  spec.summary       = "A Jekyll plugin to provide information about your Jekyll site"
+  spec.homepage      = "https://github.com/swestmoreland/jekyll-info"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", "~> 3.3"
+end

data/lib/jekyll-info.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "jekyll-info/generator"
+
+module JekyllInfo
+  autoload :PageWithoutAFile, "jekyll-info/page-without-a-file.rb"
+end

data/lib/jekyll-info/generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module JekyllInfo
+  class Generator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    # Main plugin action, called by Jekyll-core
+    def generate(site)
+      @site = site
+      return if file_exists?(template_path)
+      @site.pages << content_for_file(template_path, template_source_path)
+    end
+
+    private
+
+    # Matches all whitespace that follows
+    #   1. A '>', which closes an XML tag or
+    #   2. A '}', which closes a Liquid tag
+    # We will strip all of this whitespace to minify the template
+    MINIFY_REGEX = %r!(?<=>|})\s+!
+
+    # Path to jekyll-info from config, or jekyll-info.html for default
+    def template_path
+      if @site.config["info"] && @site.config["info"]["path"]
+        @site.config["info"]["path"]
+      else
+        "jekyll-info.html"
+      end
+    end
+
+    # Path to jekyll-info.html template file
+    def template_source_path
+      File.expand_path "jekyll-info.html", __dir__
+    end
+
+    # Checks if a file already exists in the site source
+    def file_exists?(file_path)
+      if @site.respond_to?(:in_source_dir)
+        File.exist? @site.in_source_dir(file_path)
+      else
+        File.exist? Jekyll.sanitized_path(@site.source, file_path)
+      end
+    end
+
+    # Generates contents for a file
+    def content_for_file(file_path, file_source_path)
+      file = PageWithoutAFile.new(@site, __dir__, "", file_path)
+      file.content = File.read(file_source_path).gsub(MINIFY_REGEX, "")
+      file.data["layout"] = nil
+      file.data["sitemap"] = false
+      file.output
+      file
+    end
+  end
+end

data/lib/jekyll-info/jekyll-info.html

@@ -0,0 +1,497 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <meta name="robots" content="noindex, nofollow, noarchive">
+  <title>Jekyll v{{ jekyll.version }}</title>
+  <style type="text/css">
+    body {
+      background: #fff;
+      color: #212529;
+      font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
+      font-size: .875rem;
+      line-height: 1.5;
+      margin: 1.5rem;
+    }
+    h1 {
+      font-size: 1.75rem;
+      margin: 1.5rem 0 .5rem;
+    }
+    h2 {
+      font-size: 1.25rem;
+      margin: .5rem 0;
+    }
+    table {
+      border-collapse: collapse;
+      margin: .5rem 0;
+      max-width: 100%;
+      table-layout: fixed;
+      width: 100%;
+    }
+    table th,
+    table td {
+      border: 1px solid #dee2e6;
+      padding: .33rem;
+      text-align: left;
+      vertical-align: top;
+    }
+    table thead th {
+      background-color: #e9ecef;
+      color: #495057;
+    }
+    table thead th,
+    table thead td {
+      border-bottom: 2px solid #dee2e6;
+      text-align: left;
+      vertical-align: bottom;
+    }
+    table tbody th {
+      background-color: #f8f9fa;
+    }
+    table tbody + tbody {
+      border-top: 2px solid #dee2e6;
+    }
+    .indent {
+      text-indent: 1rem;
+    }
+    .right {
+      text-align: right;
+    }
+  </style>
+</head>
+<body>
+<main class="page" role="main">
+
+  <h1 id="jekyll-info">Jekyll-Info</h1>
+  <table>
+    <tbody>
+      <tr>
+        <th>Time</th>
+        <td class="right">{{ site.time }}</td>
+      </tr>
+      <tr>
+        <th>URL</th>
+        <td class="right"><a href="{{ site.url }}">{{ site.url }}</a></td>
+      </tr>
+    </tbody>
+  </table>
+  <table>
+    <tbody>
+      <tr>
+        <th><a href="#collections">Collections</a></th>
+        <td class="right">{{ site.collections | size }}</td>
+      </tr>
+      {% for collection in site.collections %}
+      <tr>
+        <th class="indent"><a href="#documents-in-{{ collection.label }}">{{ collection.label }}</a></th>
+        <td class="right">{{ collection.docs | size }}</td>
+      </tr>
+      {% endfor %}
+      <tr>
+        <th><a href="#data-files">Data Files</a></th>
+        <td class="right">{{ site.data | size }}</td>
+      </tr>
+      <tr>
+        <th><a href="#pages">Pages</a></th>
+        <td class="right">{{ site.pages | size }}</td>
+      </tr>
+      <tr>
+        <th><a href="#static-files">Static Files</a></th>
+        <td class="right">{{ site.static_files | size }}</td>
+      </tr>
+    </tbody>
+  </table>
+  <table>
+    <tbody>
+      <tr>
+        <th>Categories</th>
+        <td>
+          {%- for category in site.categories -%}
+            {{category[0]}}{% unless forloop.last %}, {% endunless %}
+          {%- endfor -%}
+        </td>
+      </tr>
+      <tr>
+        <th>Tags</th>
+        <td>
+          {%- for tag in site.tags -%}
+            {{tag[0]}}{% unless forloop.last %}, {% endunless %}
+          {%- endfor -%}
+        </td>
+      </tr>
+    </tbody>
+  </table>
+
+  <h1 id="configuration">Configuration</h1>
+  <table>
+    <thead>
+      <tr>
+        <th colspan="2">jekyll</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>version</th>
+        <td>{{ jekyll.version }}</td>
+      </tr>
+      <tr>
+        <th>environment</th>
+        <td>{{ jekyll.environment }}</td>
+      </tr>
+    </tbody>
+    <thead>
+      <tr>
+        <th colspan="2">site</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>source</th>
+        <td>{{ site.source }}</td>
+      </tr>
+      <tr>
+        <th>destination</th>
+        <td>{{ site.destination }}</td>
+      </tr>
+      <tr>
+        <th>collections_dir</th>
+        <td>{{ site.collections_dir }}</td>
+      </tr>
+      <tr>
+        <th>data_dir</th>
+        <td>{{ site.data_dir }}</td>
+      </tr>
+      <tr>
+        <th>includes_dir</th>
+        <td>{{ site.includes_dir }}</td>
+      </tr>
+      <tr>
+        <th>layouts_dir</th>
+        <td>{{ site.layouts_dir }}</td>
+      </tr>
+      <tr>
+        <th>plugins_dir</th>
+        <td>{{ site.plugins_dir }}</td>
+      </tr>
+      <tr>
+        <th>safe</th>
+        <td>{{ site.safe }}</td>
+      </tr>
+      <tr>
+        <th>include</th>
+        <td>{{ site.include | join: ", " }}</td>
+      </tr>
+      <tr>
+        <th>exclude</th>
+        <td>{{ site.exclude | join: ", " }}</td>
+      </tr>
+      <tr>
+        <th>keep_files</th>
+        <td>{{ site.keep_files | join: ", " }}</td>
+      </tr>
+      <tr>
+        <th>encoding</th>
+        <td>{{ site.encoding }}</td>
+      </tr>
+      <tr>
+        <th>markdown_ext</th>
+        <td>{{ site.markdown_ext }}</td>
+      </tr>
+      <tr>
+        <th>strict_front_matter</th>
+        <td>{{ site.strict_front_matter }}</td>
+      </tr>
+      <tr>
+        <th>show_drafts</th>
+        <td>{{ site.show_drafts }}</td>
+      </tr>
+      <tr>
+        <th>limit_posts</th>
+        <td>{{ site.limit_posts }}</td>
+      </tr>
+      <tr>
+        <th>future</th>
+        <td>{{ site.future }}</td>
+      </tr>
+      <tr>
+        <th>unpublished</th>
+        <td>{{ site.unpublished }}</td>
+      </tr>
+      <tr>
+        <th>whitelist</th>
+        <td>{{ site.whitelist | join: ", " }}</td>
+      </tr>
+      <tr>
+        <th>plugins</th>
+        <td>{{ site.plugins | join: ", " }}</td>
+      </tr>
+      <tr>
+        <th>markdown</th>
+        <td>{{ site.markdown }}</td>
+      </tr>
+      <tr>
+        <th>highlighter</th>
+        <td>{{ site.highlighter }}</td>
+      </tr>
+      <tr>
+        <th>lsi</th>
+        <td>{{ site.lsi }}</td>
+      </tr>
+      <tr>
+        <th>excerpt_separator</th>
+        <td>{{ site.excerpt_separator }}</td>
+      </tr>
+      <tr>
+        <th>incremental</th>
+        <td>{{ site.incremental }}</td>
+      </tr>
+      <tr>
+        <th>detach</th>
+        <td>{{ site.detach }}</td>
+      </tr>
+      <tr>
+        <th>port</th>
+        <td>{{ site.port }}</td>
+      </tr>
+      <tr>
+        <th>host</th>
+        <td>{{ site.host }}</td>
+      </tr>
+      <tr>
+        <th>baseurl</th>
+        <td>{{ site.baseurl }}</td>
+      </tr>
+      <tr>
+        <th>show_dir_listing</th>
+        <td>{{ site.show_dir_listing }}</td>
+      </tr>
+      <tr>
+        <th>permalink</th>
+        <td>{{ site.permalink }}</td>
+      </tr>
+      <tr>
+        <th>paginate_path</th>
+        <td>{{ site.paginate_path }}</td>
+      </tr>
+      <tr>
+        <th>timezone</th>
+        <td>{{ site.timezone }}</td>
+      </tr>
+      <tr>
+        <th>quiet</th>
+        <td>{{ site.quiet }}</td>
+      </tr>
+      <tr>
+        <th>verbose</th>
+        <td>{{ site.verbose }}</td>
+      </tr>
+    </tbody>
+    {% for collection in site.collections %}
+    <thead>
+      <tr>
+        <th colspan="2">site.collections.{{ collection.label }}</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>relative_directory</th>
+        <td>{{ collection.relative_directory }}</td>
+      </tr>
+      <tr>
+        <th>directory</th>
+        <td>{{ collection.directory }}</td>
+      </tr>
+      <tr>
+        <th>output</th>
+        <td>{{ collection.output }}</td>
+      </tr>
+    </tbody>
+    {% endfor %}
+    <thead>
+      <tr>
+        <th colspan="2">site.defaults</th>
+      </tr>
+    </thead>
+    {% for default in site.defaults %}
+    <tbody>
+      <tr>
+        <th colspan="2">scope</th>
+      </tr>
+      {% for value in default.scope %}
+      <tr>
+        <th class="indent">{{ value[0] }}</th>
+        <td>{{ value[1] }}</td>
+      </tr>
+      {% endfor %}
+      <tr>
+        <th colspan="2">values</th>
+      </tr>
+      {% for value in default.values %}
+      <tr>
+        <th class="indent">{{ value[0] }}</th>
+        <td>{{ value[1] }}</td>
+      </tr>
+      {% endfor %}
+    </tbody>
+    {% endfor %}
+    <thead>
+      <tr>
+        <th colspan="2">site.liquid</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>error_mode</th>
+        <td>{{ site.liquid.error_mode }}</td>
+      </tr>
+      <tr>
+        <th>strict_filters</th>
+        <td>{{ site.liquid.strict_filters }}</td>
+      </tr>
+      <tr>
+        <th>strict_variables</th>
+        <td>{{ site.liquid.strict_variables }}</td>
+      </tr>
+    </tbody>
+    <thead>
+      <tr>
+        <th colspan="2">site.rdiscount</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>extensions</th>
+        <td>{{ site.rdiscount.extensions | join: ", " }}</td>
+      </tr>
+    </tbody>
+    <thead>
+      <tr>
+        <th colspan="2">site.redcarpet</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>extensions</th>
+        <td>{{ site.redcarpet.extensions | join: ", " }}</td>
+      </tr>
+    </tbody>
+    <thead>
+      <tr>
+        <th colspan="2">site.kramdown</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <th>auto_ids</th>
+        <td>{{ site.kramdown.auto_ids }}</td>
+      </tr>
+      <tr>
+        <th>entity_output</th>
+        <td>{{ site.kramdown.entity_output }}</td>
+      </tr>
+      <tr>
+        <th>toc_levels</th>
+        <td>{{ site.kramdown.toc_levels }}</td>
+      </tr>
+      <tr>
+        <th>smart_quotes</th>
+        <td>{{ site.kramdown.smart_quotes }}</td>
+      </tr>
+      <tr>
+        <th>input</th>
+        <td>{{ site.kramdown.input }}</td>
+      </tr>
+      <tr>
+        <th>hard_wrap</th>
+        <td>{{ site.kramdown.hard_wrap }}</td>
+      </tr>
+      <tr>
+        <th>footnote_nr</th>
+        <td>{{ site.kramdown.footnote_nr }}</td>
+      </tr>
+      <tr>
+        <th>show_warnings</th>
+        <td>{{ site.kramdown.show_warnings }}</td>
+      </tr>
+    </tbody>
+  </table>
+
+  <h1 id="collections">Collections</h1>
+  {% for collection in site.collections %}
+  <h2 id="documents-in-{{ collection.label }}">Documents in {{ collection.label }}</h2>
+  <table>
+    <colgroup>
+      <col class="title">
+      <col class="path">
+      <col class="date">
+    </colgroup>
+    <thead>
+      <tr>
+        <th>title</th>
+        <th>path</th>
+        <th>date</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for doc in collection.docs %}
+      <tr>
+        <td><a href="{{ doc.url | absolute_url }}">{{ doc.title }}</a></td>
+        <td>{{ doc.path }}</td>
+        <td>{{ doc.date | date_to_xmlschema }}</td>
+      </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% endfor %}
+
+  <h1 id="pages">Pages</h1>
+  <table>
+    <colgroup>
+      <col class="title">
+      <col class="path">
+      <col class="date">
+    </colgroup>
+    <thead>
+      <tr>
+        <th>title</th>
+        <th>path</th>
+        <th>date</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for doc in site.pages %}
+      <tr>
+        <td><a href="{{ doc.url | absolute_url }}">{{ doc.title }}</a></td>
+        <td>{{ doc.path }}</td>
+        <td>{{ doc.date | date_to_xmlschema }}</td>
+      </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+
+  <h1 id="static-files">Static Files</h1>
+  <table>
+    <colgroup>
+      <col class="path">
+      <col class="modified_time">
+    </colgroup>
+    <thead>
+      <tr>
+        <th>path</th>
+        <th>modified_time</th>
+      </tr>
+    </thead>
+    <tbody>
+      {% for file in site.static_files %}
+      <tr>
+        <td>{{ file.path | remove_first: "/" }}</td>
+        <td>{{ file.modified_time | date_to_xmlschema }}</td>
+      </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+
+</main>
+</body>
+</html>

data/lib/jekyll-info/page-without-a-file.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module JekyllInfo
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/jekyll-info/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Info
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-info
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Westmoreland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- steven.westmoreland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- jekyll-info.gemspec
+- lib/jekyll-info.rb
+- lib/jekyll-info/generator.rb
+- lib/jekyll-info/jekyll-info.html
+- lib/jekyll-info/page-without-a-file.rb
+- lib/jekyll-info/version.rb
+homepage: https://github.com/swestmoreland/jekyll-info
+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.10
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to provide information about your Jekyll site
+test_files: []