From b31d67d22262a26ad48c7532d549c5245960486d Mon Sep 17 00:00:00 2001 From: Ashwin Maroli Date: Wed, 22 Jan 2020 23:47:50 +0530 Subject: [PATCH] Drop support for scalar 'author' configuration (#384) Merge pull request 384 --- README.md | 17 +++++++++++++++++ _config.yml | 7 ++++--- _includes/footer.html | 10 ++++++---- 3 files changed, 27 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bfdbcf8e88..00f7a715e1 100644 --- a/README.md +++ b/README.md @@ -209,6 +209,23 @@ If you don't want to display comments for a particular post you can disable them :warning: `url`, e.g. `https://example.com`, must be set in you config file for Disqus to work. +### Author Metadata + +From `Minima-3.0` onwards, `site.author` is expected to be a mapping of attributes instead of a simple scalar value: + +```yaml +author: + name: John Smith + email: "john.smith@foobar.com" +``` + +To migrate existing metadata, update your config file and any reference to the object in your layouts and includes as summarized below: + +Minima 2.x | Minima 3.0 +------------- | ------------------- +`site.author` | `site.author.name` +`site.email` | `site.author.email` + ### Social networks diff --git a/_config.yml b/_config.yml index f8872399af..10c9d42be0 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,7 @@ title: Your awesome title -author: GitHub User -email: your-email@domain.com +author: + name: GitHub User + email: your-email@domain.com description: > # this means to ignore newlines until "show_excerpts:" Write an awesome description for your new site here. You can edit this line in _config.yml. It will appear in your document head meta (for @@ -46,7 +47,7 @@ minima: # instance: example.com # - username: jekyll2 # instance: example.com - + # If you want to link only specific pages in your header, uncomment # this and add the path to the pages in order as they should show up #header_pages: diff --git a/_includes/footer.html b/_includes/footer.html index 54643ff9dc..460c46d5f4 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -6,14 +6,16 @@