Document site.subtitle

This commit is contained in:
Michael Rose 2019-07-17 11:50:21 -04:00
parent 8b708a0ee3
commit 3bbfeac62d
4 changed files with 11 additions and 2 deletions

View file

@ -18,6 +18,7 @@ minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt"
locale : "en-US" locale : "en-US"
title : "Site Title" title : "Site Title"
title_separator : "-" title_separator : "-"
subtitle : # site tagline that appears below site title in masthead
name : "Your Name" name : "Your Name"
description : "An amazing website." description : "An amazing website."
url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"

View file

@ -13,6 +13,7 @@ minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt"
locale : "en-US" locale : "en-US"
title : "Minimal Mistakes" title : "Minimal Mistakes"
title_separator : "-" title_separator : "-"
subtitle : # site tagline that appears below site title in masthead
name : &name "Michael Rose" # &name is a YAML anchor which can be *referenced later name : &name "Michael Rose" # &name is a YAML anchor which can be *referenced later
description : &description "A flexible Jekyll theme for your blog or site with a minimalist aesthetic." description : &description "A flexible Jekyll theme for your blog or site with a minimalist aesthetic."
url : https://mmistakes.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" url : https://mmistakes.github.io # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"

View file

@ -2,7 +2,7 @@
title: "Configuration" title: "Configuration"
permalink: /docs/configuration/ permalink: /docs/configuration/
excerpt: "Settings for configuring and customizing the theme." excerpt: "Settings for configuring and customizing the theme."
last_modified_at: 2019-01-15T08:31:44-05:00 last_modified_at: 2019-07-17T11:50:08-04:00
toc: true toc: true
--- ---
@ -134,6 +134,12 @@ _Example:_ `title_separator: "|"` would produce page titles like `Sample Page |
**Note:** Long site titles have been known to break the masthead layout. Avoid adding a long "tagline" to the title prevent this from happening eg. `My Awesome Site is the Best Because I Say So". **Note:** Long site titles have been known to break the masthead layout. Avoid adding a long "tagline" to the title prevent this from happening eg. `My Awesome Site is the Best Because I Say So".
{: .notice--warning} {: .notice--warning}
### Site subtitle
A short tagline that appears below the title in site masthead.
_Example:_ `subtitle: "Version 2.0"`
### Site name ### Site name
Used to assign a site author. Don't worry, you can override the site author with different ones on specific posts, pages, or collection documents. Used to assign a site author. Don't worry, you can override the site author with different ones on specific posts, pages, or collection documents.

View file

@ -10,8 +10,9 @@ minimal_mistakes_skin : "default" # "air", "aqua", "contrast", "dark", "dirt"
# Site Settings # Site Settings
locale : "en-US" locale : "en-US"
title : "Minimal Mistakes Development Test Site" title : "Minimal Mistakes"
title_separator : "-" title_separator : "-"
subtitle : "Development Test Site"
name : "Your Name" name : "Your Name"
description : "Minimal Mistakes theme test." description : "Minimal Mistakes theme test."
url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io" url : # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"