jekyll-titles-from-headings 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9be84447c8ef2d9c7524d0597ed0554f86921400
-  data.tar.gz: fcea154a73a1c77c91fc474d55f72304ae207f26
+  metadata.gz: 72fa914e6e3a049002a1f8b7ea2e9e27e7e72828
+  data.tar.gz: c40c43c7606cf23b0b78c70bc90ec1df5f65bb77
 SHA512:
-  metadata.gz: 86d521565b46e9113f816d7713080232bdb3b77be9504dd05c61b2f6c9c4b7fc538e55230a9576907edccc7b643d1df406cafa44bddbb3d7303632745105032c
-  data.tar.gz: 895456a1a6e7f80c6726f932acabc0ad2a131b8cc5ab48e168b2467ffbda1632413b60d914bacbbc32bf706bde057d168f56a9127850d7c32b61961959ea17bb
+  metadata.gz: 12b31cbcc1a5bf70721e1c614a908c49c42290ae902b133ae64848af385c2e7f7b9f007d87d234929037b1f158588e2c156a6323361108949c1172f16e290ed1
+  data.tar.gz: 730f1cad5650da5490e37043ac26b664da99a228a2bc277e9e938195d94f14b7c349fc9d4bbeb6a12893c7b9a644367cf3113d012cbbd77a82821ddff41344a9

data/README.md

@@ -1,8 +1,8 @@
-# Jekyll Title from Headings
+# Jekyll Titles from Headings
 
 *A Jekyll plugin to pull the page title from the first Markdown heading when none is specified.*
 
-[![Build Status](https://travis-ci.org/benbalter/jekyll-title-from-headings.svg?branch=master)](https://travis-ci.org/benbalter/jekyll-title-from-headings)
+[![Build Status](https://travis-ci.org/benbalter/jekyll-titles-from-headings.svg?branch=master)](https://travis-ci.org/benbalter/jekyll-titles-from-headings)
 
 ## What it does
 
@@ -30,3 +30,39 @@ Additionally, this allows you to store the title semantically, in the document i
   gems:
     - jekyll-titles-from-headings
   ```
+
+## Configuration
+
+Configuration options are optional and placed in `_config.yml` under the `titles_from_headings` key. They default to:
+
+```yml
+titles_from_headings:
+  enabled:     true
+  strip_title: false
+  collections: false
+```
+
+### Stripping titles
+
+If your theme renders titles based on `page.title`, you can remove the title from the content by setting `strip_title` to prevent rendering it twice.
+
+To limit this behavior to a certain layouts or paths, you can use [front matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults), e.g.
+
+```yml
+defaults:
+  - scope:
+      path: some-path
+      layout: some_layout
+    values:
+      strip_title: true
+```
+
+### Processing Collections
+
+If you want to enable this plugin for collection items, set the `collections` option to `true`.
+
+Since collection items (including posts) already have a title inferred from their filename, this option changes the behavior of this plugin to override the inferred title. The inferred title is only used as a fallback in case the document doesn't start with a heading.
+
+### Disabling
+
+Even if the plugin is enabled (e.g., via the `:jekyll_plugins` group in your Gemfile) you can disable it by setting the `enabled` key to `false`.

data/lib/jekyll-titles-from-headings/generator.rb

@@ -20,6 +20,11 @@ module JekyllTitlesFromHeadings
     # (footnotes at the moment).
     EXTRA_MARKUP_REGEX = %r!\[\^[^\]]*\]!
 
+    CONFIG_KEY = "titles_from_headings".freeze
+    ENABLED_KEY = "enabled".freeze
+    STRIP_TITLE_KEY = "strip_title".freeze
+    COLLECTIONS_KEY = "collections".freeze
+
     safe true
     priority :lowest
 
@@ -29,10 +34,15 @@ module JekyllTitlesFromHeadings
 
     def generate(site)
       @site = site
+      return if disabled?
+
+      documents = site.pages
+      documents = site.pages + site.docs_to_write if collections?
 
-      site.pages.each do |document|
+      documents.each do |document|
         next unless should_add_title?(document)
         document.data["title"] = title_for(document)
+        strip_title!(document) if strip_title?(document)
       end
     end
 
@@ -41,7 +51,7 @@ module JekyllTitlesFromHeadings
     end
 
     def title?(document)
-      !document.data["title"].nil?
+      !inferred_title?(document) && !document.data["title"].nil?
     end
 
     def markdown?(document)
@@ -55,7 +65,8 @@ module JekyllTitlesFromHeadings
     def title_for(document)
       return document.data["title"] if title?(document)
       matches = document.content.match(TITLE_REGEX)
-      strip_markup(matches[1] || matches[2]) if matches
+      return strip_markup(matches[1] || matches[2]) if matches
+      document.data["title"] # If we cant match a title, we use the inferred one.
     rescue ArgumentError => e
       raise e unless e.to_s.start_with?("invalid byte sequence in UTF-8")
     end
@@ -68,6 +79,36 @@ module JekyllTitlesFromHeadings
       end.gsub(EXTRA_MARKUP_REGEX, "")
     end
 
+    def option(key)
+      site.config[CONFIG_KEY] && site.config[CONFIG_KEY][key]
+    end
+
+    def disabled?
+      option(ENABLED_KEY) == false
+    end
+
+    def strip_title?(document)
+      if document.data.key?(STRIP_TITLE_KEY)
+        document.data[STRIP_TITLE_KEY] == true
+      else
+        option(STRIP_TITLE_KEY) == true
+      end
+    end
+
+    def collections?
+      option(COLLECTIONS_KEY) == true
+    end
+
+    # Documents (posts and collection items) have their title inferred from the filename.
+    # We want to override these titles, because they were not excplicitly set.
+    def inferred_title?(document)
+      document.is_a?(Jekyll::Document)
+    end
+
+    def strip_title!(document)
+      document.content.gsub!(TITLE_REGEX, "")
+    end
+
     def filters
       @filters ||= JekyllTitlesFromHeadings::Filters.new(site)
     end

data/lib/jekyll-titles-from-headings/version.rb

@@ -1,3 +1,3 @@
 module JekyllTitlesFromHeadings
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-titles-from-headings
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll