Allow removing site title from page title

Author: imustafin

docs/advanced-usage.md

@@ -2,16 +2,6 @@
 
 Jekyll SEO Tag is designed to implement SEO best practices by default and to be the right fit for most sites right out of the box. If for some reason, you need more control over the output, read on:
 
-### Disabling `<title>` output
-
-If for some reason, you don't want the plugin to output `<title>` tags on each page, simply invoke the plugin within your template like so:
-
-<!-- {% raw %} -->
-```
-{% seo title=false %}
-```
-<!-- {% endraw %} -->
-
 ### Disabling `<link rel="canonical">` output
 
 If you're using another plugin to generate canonical URLs (such as [jekyll-polyglot](https://github.com/untra/polyglot) for multilingual sites), you can disable the canonical URL output:
@@ -188,7 +178,42 @@ Which will generate following canonical_url:
 <link rel="canonical" href="https://example.com/title-of-your-post" />
 ```
 
-### Customizing title modifier for paginated pages
+### Customizing title
+Jekyll SEO tag outputs the `<title>` tag and automatically adds several
+important details such as the site title, page number for paginated
+pages, and can add the page category if applicable.
+
+#### Disabling `<title>` output
+
+If for some reason, you don't want the plugin to output `<title>` tags on each page, simply invoke the plugin within your template like so:
+
+```
+{% seo title=false %}
+```
+
+#### Removing site title from the page title
+The site title is appended to the majority as: `Page title | Site title`.
+
+You can configure the site title by setting either `title` or `name` in `_config.yml`.
+```yml
+title: Site title
+```
+
+Site title is not added on the "home" and "about" pages. Those pages
+are identified by the page's `url`.
+
+You can override it by adding `homepage_or_about` to the page's front matter:
+
+```yml
+---
+homepage_or_about: false
+---
+```
+
+Setting `homepage_or_about: false` prevents the site name
+from being added the page title.
+
+#### Customizing title modifier for paginated pages
 
 You can override the default title modifier for paginated pages from `Page %{current} of %{total} for ` to a string of your
 choice by setting a `seo_paginator_message` key in your `_config.yml`.
@@ -202,7 +227,7 @@ seo_paginator_message: "%<current>s / %<total>s | "
 While the value can be any string text, we recommend using a Ruby string-template containing the variables `current` and `total`
 similar to the example above, to incorporate the current page-number and total number of paginated pages in the title.
 
-### Adding a page title category
+#### Adding a page title category
 
 You can optionally add a page category to its title.
 This is useful for indicating to the users that some pages are logically grouped or are of a specific kind.

lib/jekyll-seo-tag/drop.rb

@@ -70,10 +70,9 @@ def site_tagline_or_description
       end
 
       # Page title with site title or description appended
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def title
+      def title # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize
         @title ||= begin
-          if site_title && page_title != site_title
+          if site_title && !homepage_or_about? && page_title != site_title
             page_title + TITLE_SEPARATOR + site_title
           elsif site_description && site_title
             site_title + TITLE_SEPARATOR + site_tagline_or_description
@@ -86,7 +85,6 @@ def title
 
         @title
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       def name
         return @name if defined?(@name)
@@ -210,7 +208,11 @@ def site
       end
 
       def homepage_or_about?
-        page["url"] =~ HOMEPAGE_OR_ABOUT_REGEX
+        if page.key?("homepage_or_about")
+          page["homepage_or_about"]
+        else
+          page["url"] =~ HOMEPAGE_OR_ABOUT_REGEX
+        end
       end
 
       def page_number

spec/jekyll_seo_tag/drop_spec.rb

@@ -168,6 +168,15 @@
           expect(subject.title).to be_nil
         end
       end
+
+      context "with a home_or_about page and a site title" do
+        let(:config) { { "title" => "site title" } }
+        let(:page_meta) { { "permalink" => "/", "title" => "page title" } }
+
+        it "is just the page title" do
+          expect(subject.title).to eql("page title")
+        end
+      end
     end
   end
 
@@ -507,6 +516,22 @@
       end
     end
 
+    context "when page has homepage_or_about" do
+      let(:page_meta) { { "homepage_or_about" => true } }
+
+      it "knows it's the home or about page" do
+        expect(subject.send(:homepage_or_about?)).to be_truthy
+      end
+
+      context "with homepage_or_about=false" do
+        let(:page_meta) { { "homepage_or_about" => false } }
+
+        it "knows it's not the home or about page" do
+          expect(subject.send(:homepage_or_about?)).to be_falsy
+        end
+      end
+    end
+
     context "a random URL" do
       let(:page_meta) { { "permalink" => "/about-foo/" } }