🔖 Release v1.4.0

CHANGELOG.md

@@ -6,6 +6,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [1.4.0] - 2021-10-20
+
+### Added
+
+- Footer menu
+- Article summary support
+- Slate colour scheme ([#9](https://github.com/jpanther/congo/pull/9))
+- Icons for ORCID and ResearchGate ([#9](https://github.com/jpanther/congo/pull/9))
+- Pinterest sharing links
+- Sharing links can now be specified in front matter
+
+### Changed
+
+- Main menu is now optional
+- Upgrade to Mermaid v8.13.3
+- Upgrade to Tailwind v2.2.17
+
+### Fixed
+
+- Site logo not linked to home page ([#13](https://github.com/jpanther/congo/issues/13))
+
 ## [1.3.0] - 2021-09-29
 
 ### Added
@@ -55,13 +76,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Some links missing the correct styles when in Firefox
 - `externalUrl` front matter not working on some list pages
 
-## [1.1.1] - 2020-08-19
+## [1.1.1] - 2021-08-19
 
 ### Fixed
 
 - Hotfix for exampleSite and GitHub configuration
 
-## [1.1.0] - 2020-08-18
+## [1.1.0] - 2021-08-18
 
 ### Added
 
@@ -83,7 +104,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - URLs being incorrect in some cases when the site is deployed in a subfolder
 
-## [1.0.0] - 2020-08-16
+## [1.0.0] - 2021-08-16
 
 ### Added
 
@@ -106,7 +127,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Advanced customisation using simple Tailwind colour definitions and styles
 - Fully documented
 
-[unreleased]: https://github.com/jpanther/Congo/compare/v1.3.0...HEAD
+[unreleased]: https://github.com/jpanther/Congo/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/jpanther/Congo/compare/v1.3.0...v1.4.0
 [1.3.0]: https://github.com/jpanther/Congo/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/jpanther/Congo/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/jpanther/Congo/compare/v1.1.1...v1.2.0

assets/css/compiled/main.css

@@ -1,6 +1,6 @@
-/*! Congo v1.3.0 | MIT License | https://github.com/jpanther/congo */
+/*! Congo v1.4.0 | MIT License | https://github.com/jpanther/congo */
 
-/*! tailwindcss v2.2.16 | MIT License | https://tailwindcss.com */
+/*! tailwindcss v2.2.17 | MIT License | https://tailwindcss.com */
 
 /*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */
 
@@ -2299,6 +2299,11 @@ body a, body button {
   padding-right: 0.25rem;
 }
 
+.py-1 {
+  padding-top: 0.25rem;
+  padding-bottom: 0.25rem;
+}
+
 .py-\[1px\] {
   padding-top: 1px;
   padding-bottom: 1px;
@@ -2341,6 +2346,10 @@ body a, body button {
   padding-top: 0.75rem;
 }
 
+.pb-4 {
+  padding-bottom: 1rem;
+}
+
 .pt-4 {
   padding-top: 1rem;
 }

assets/css/main.css

@@ -1,4 +1,4 @@
-/*! Congo v1.3.0 | MIT License | https://github.com/jpanther/congo */
+/*! Congo v1.4.0 | MIT License | https://github.com/jpanther/congo */
 
 @tailwind base;
 @tailwind components;

assets/css/schemes/slate.css

@@ -0,0 +1,37 @@
+/* Slate scheme */
+:root {
+  --color-neutral: #fff;
+  /* Cool Gray */
+  --color-neutral-50: #F9FAFB;
+  --color-neutral-100: #F3F4F6;
+  --color-neutral-200: #E5E7EB;
+  --color-neutral-300: #D1D5DB;
+  --color-neutral-400: #9CA3AF;
+  --color-neutral-500: #6B7280;
+  --color-neutral-600: #4B5563;
+  --color-neutral-700: #374151;
+  --color-neutral-800: #1F2937;
+  --color-neutral-900: #111827;
+  /* Cool Gray */
+  --color-primary-50: #F9FAFB;
+  --color-primary-100: #F3F4F6;
+  --color-primary-200: #E5E7EB;
+  --color-primary-300: #D1D5DB;
+  --color-primary-400: #9CA3AF;
+  --color-primary-500: #6B7280;
+  --color-primary-600: #4B5563;
+  --color-primary-700: #374151;
+  --color-primary-800: #1F2937;
+  --color-primary-900: #111827;
+  /* Cool Gray */
+  --color-secondary-50: #F9FAFB;
+  --color-secondary-100: #F3F4F6;
+  --color-secondary-200: #E5E7EB;
+  --color-secondary-300: #D1D5DB;
+  --color-secondary-400: #9CA3AF;
+  --color-secondary-500: #6B7280;
+  --color-secondary-600: #4B5563;
+  --color-secondary-700: #374151;
+  --color-secondary-800: #1F2937;
+  --color-secondary-900: #111827;
+}

config/_default/config.toml

@@ -12,6 +12,8 @@ title = "Congo"
 enableEmoji = true
 enableRobotsTXT = true
 
+summaryLength = 0
+
 [author]
   # name = "Your name here"
   # image = "img/author.jpg"

config/_default/menus.toml

@@ -1,5 +1,5 @@
 # -- Main Menu --
-# The main menu is displayed at the top of the theme.
+# The main menu is displayed in the header at the top of the page.
 # Acceptable parameters are name, pageRef, page, url, title, weight.
 # 
 # The simplest menu configuration is to provide:
@@ -24,3 +24,13 @@
   name = "Tags"
   pageRef = "tags"
   weight = 30
+
+
+# -- Footer Menu --
+# The footer menu is displayed at the bottom of the page, just before
+# the copyright notice. Configure as per the main menu above.
+
+# [[footer]]
+#   name = "Tags"
+#   pageRef = "tags"
+#   weight = 10

config/_default/params.toml

@@ -27,10 +27,11 @@ colorScheme = "congo"
   showHeadingAnchors = true
   showPagination = true
   showReadingTime = true
-  # sharingLinks = ["facebook", "twitter", "reddit", "linkedin", "email"]
+  # sharingLinks = ["facebook", "twitter", "pinterest", "reddit", "linkedin", "email"]
 
 [list]
   showBreadcrumbs = false
+  showSummary = false
   groupByYear = true
 
 [taxonomy]

data/sharing.json

@@ -14,6 +14,11 @@
     "title": "sharing.linkedin",
     "url": "https://www.linkedin.com/shareArticle?mini=true&url=%s&title=%s"
   },
+  "pinterest": {
+    "icon": "pinterest",
+    "title": "sharing.pinterest",
+    "url": "https://pinterest.com/pin/create/bookmarklet/?url=%s&description=%s"
+  },
   "reddit": {
     "icon": "reddit",
     "title": "sharing.reddit",

exampleSite/config.toml

@@ -12,6 +12,7 @@ languageCode = "en-AU"
 defaultContentLanguage = "en"
 title = "Congo"
 enableEmoji = true
+summaryLength = 0
 
 [author]
   name = "Congo"

exampleSite/content/docs/advanced-customisation.md

@@ -11,9 +11,9 @@ There are a few ways you can make style changes to Congo.
 
 ## Colour schemes
 
-Congo ships with a few colour schemes out of the box. To change the basic colour scheme, you can set the `colorScheme` theme parameter to one of the default configurations. Valid options are `congo` (the default), `avocado`, `fire` and `ocean`.
+Congo ships with a number of colour schemes out of the box. To change the basic colour scheme, you can set the `colorScheme` theme parameter. Refer to the [Getting Started]({{< ref "getting-started#colour-schemes" >}}) section to learn more about the built-in schemes.
 
-In addition to the default scheme, you can also create your own and restyle the entire website to your liking. Schemes are created by by placing a `<scheme-name>.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration.
+In addition to the default schemes, you can also create your own and re-style the entire website to your liking. Schemes are created by by placing a `<scheme-name>.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration.
 
 Congo defines a three-colour palette that is used throughout the theme. The three colours are defined as `neutral`, `primary` and `secondary` variants, each containing ten shades of colour.
 

exampleSite/content/docs/configuration.md

@@ -19,7 +19,7 @@ The default theme configuration is documented in each file so you can freely adj
 As outlined in the [installation instructions]({{< ref "/docs/installation#set-up-theme-configuration-files" >}}), you should adjust your theme configuration by modifying the files in the `config/_default/` folder of your Hugo project and delete the `config.toml` file in your project root.
 {{< /alert >}}
 
-## Site Configuration
+## Site configuration
 
 Standard Hugo configuration variables are respected throughout the theme, however there are some specific things that should be configured for the best experience.
 
@@ -30,22 +30,23 @@ Note that the variable names provided in this table use dot notation to simplify
 <!-- prettier-ignore-start -->
 |Name|Type|Default|Description|
 | --- | --- | --- | --- |
-|`theme`|string|`"congo"`|When using Hugo Modules this config value should be removed. For all other installation types, this must be set to `"congo"` for the theme to function.|
+|`theme`|string|`"congo"`|When using Hugo Modules this config value should be removed. For all other installation types, this must be set to `congo` for the theme to function.|
 |`baseURL`|string|_Not set_|The URL to the root of the website.|
-|`languageCode`|string|`en`|The language of the website for site metadata purposes. It can be a top-level language (ie. `"en"`) or a sub-variant (ie. `en-AU`)."|
+|`languageCode`|string|`"en"`|The language of the website for site metadata purposes. It can be a top-level language (ie. `en`) or a sub-variant (ie. `en-AU`)."|
 |`defaultContentLanguage`|string|`"en"`|This value determines the language of theme components."|
 |`title`|string|`"Congo"`|The title of the website. This will be displayed in the site header and footer.|
 |`copyright`|string|_Not set_|A Markdown string containing the copyright message to be displayed in the site footer. If none is provided, Congo will automatically generate a copyright string using the site `title`.
 |`enableEmoji`|boolean|`true`|Whether emoji strings in content should be converted to emoji symbols.|
 |`enableRobotsTXT`|boolean|`true`|When enabled a `robots.txt` file will be created in the site root that allows search engines to crawl the entire site. Set to `false` if you wish to provide your own file.|
+|`summaryLength`|integer|`0`|The number of words that are used to generate the article summary when one is not provided in the [front matter]({{< ref "front-matter" >}}). A value of `0` will use the first sentence. This value has no effect when summaries are hidden.|
 |`author.name`|string|_Not set_|The author's name. This will be displayed in article footers, and on the homepage when the profile layout is used.|
 |`author.image`|string|_Not set_|Path to the image file of the author. The image should be a 1:1 aspect ratio and placed in the site's `static/` folder.|
 |`author.links`|array of objects|_Not set_|The links to display alongside the author's details. The config file contains example links which can simply be uncommented to enable. The order that the links are displayed is determined by the order they appear in the array. Custom links can be added by providing corresponding SVG icon assets in `assets/icons/`.|
-|`[permalinks]`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/urls/#permalinks) for permalink configuration.|
-|`[taxonomies]`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/taxonomies/) for taxonomy configuration.|
+|`permalinks`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/urls/#permalinks) for permalink configuration.|
+|`taxonomies`||_Not set_|Refer to the [Organising content]({{< ref "getting-started#organising-content" >}}) section for taxonomy configuration.|
 <!-- prettier-ignore-end -->
 
-## Theme Parameters
+## Theme parameters
 
 Congo provides a large number of configuration parameters that control how the theme functions. The table below outlines every available parameter in the `config/_default/params.toml` file.
 
@@ -54,8 +55,8 @@ Many of the article defaults here can be overridden on a per article basis by sp
 <!-- prettier-ignore-start -->
 |Name|Type|Default|Description|
 | --- | --- | --- | --- |
-|`colorScheme`|string|`"congo"`|The theme colour scheme to use. Valid values are `congo` (default), `avocado`, `ocean` and `fire`. Refer to [Advanced Customisation]({{< ref "advanced-customisation#colour-schemes" >}}) for more details.|
-|`logo`|string|_Not set_|The relative path to the site logo file within the Hugo assets folder. The logo file should be provided at 2x resolution and supports any image dimensions.|
+|`colorScheme`|string|`"congo"`|The theme colour scheme to use. Valid values are `congo` (default), `avocado`, `ocean`, `fire` and `slate`. Refer to the [Colour Schemes]({{< ref "getting-started#colour-schemes" >}}) section for more details.|
+|`logo`|string|_Not set_|The relative path to the site logo file within the `assets/` folder. The logo file should be provided at 2x resolution and supports any image dimensions.|
 |`description`|string|_Not set_|The description of the website for metadata purposes.|
 |`mainSections`|array of strings|_Not set_|The sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.|
 |`robots`|string|_Not set_|String that indicates how robots should handle your site. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.|
@@ -74,10 +75,11 @@ Many of the article defaults here can be overridden on a per article basis by sp
 |`article.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.|
 |`article.sharingLinks`|array of strings|_Not set_|Which sharing links to display at the end of each article. When not provided, or set to `false` no links will be displayed.|
 |`list.showBreadcrumbs`|boolean|`false`|Whether or not breadcrumbs are displayed in the header on list pages.|
+|`list.showSummary`|boolean|`false`|Whether or not article summaries are displayed on list pages. If a summary is not provided in the [front matter]({{< ref "front-matter" >}}), one will be auto generated using the `summaryLength` parameter in the [site configuration](#site-configuration).|
 |`list.groupByYear`|boolean|`true`|Whether or not articles are grouped by year on list pages.|
 |`sitemap.excludedKinds`|array of strings|`["taxonomy", "term"]`|Kinds of content that should be excluded from the generated `/sitemap.xml` file. Refer to the [Hugo docs](https://gohugo.io/templates/section-templates/#page-kinds) for acceptable values.|
 |`taxonomy.showTermCount`|boolean|`true`|Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.|
-|`fathomAnalytics.site`|string|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) below for more details.|
+|`fathomAnalytics.site`|string|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
 |`fathomAnalytics.domain`|string|_Not set_|If using a custom domain with Fathom Analytics, provide it here to serve `script.js` from the custom domain.|
 |`verification.google`|string|_Not set_|The site verification string provided by Google to be included in the site metadata.|
 |`verification.bing`|string|_Not set_|The site verification string provided by Bing to be included in the site metadata.|

exampleSite/content/docs/front-matter.md

@@ -7,22 +7,27 @@ slug: "front-matter"
 tags: ["front matter", "config", "docs"]
 ---
 
-In addition to the [default Hugo front matter parameters](https://gohugo.io/content-management/front-matter/#front-matter-variables), Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below.
+In addition to the [default Hugo front matter parameters](https://gohugo.io/content-management/front-matter/#front-matter-variables), Congo adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below.
 
 Front matter parameter default values are inherited from the theme's [base configuration]({{< ref "configuration" >}}), so you only need to specify these parameters in your front matter when you want to override the default.
 
 <!-- prettier-ignore-start -->
 |Name|Type|Default|Description|
 | --- | --- | --- | --- |
+|`description`|string|_Not set_|The text description for the article. It is used in the HTML metadata.|
 |`externalUrl`|string|_Not set_|If this article is published on a third-party website, the URL to this article. Providing a URL will prevent a content page being generated and any references to this article will link directly to the third-party website.|
-|`showDate`|boolean|`article.showDate`|Whether or not article dates are displayed.|
-|`showAuthor`|boolean|`article.showAuthor`|Whether or not the author box is displayed in the article footer.|
-|`showEdit`|boolean|`article.showEdit`|Whether or not the link to edit the article content should be displayed.|
 |`editURL`|string|`article.editURL`|When `showEdit` is active, the URL for the edit link.|
 |`editAppendPath`|boolean|`article.editAppendPath`|When `showEdit` is active, whether or not the path to the current article should be appended to the URL set at `editURL`.|
+|`menu`|string or array|_Not set_|When a value is provided, a link to this article will appear in the named menus. Valid values are `main` or `footer`.|
 |`robots`|string|_Not set_|String that indicates how robots should handle this article. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.|
+|`sharingLinks`|array of strings|`article.sharingLinks`|Which sharing links to display at the end of this article. When not provided, or set to `false` no links will be displayed.|
+|`showAuthor`|boolean|`article.showAuthor`|Whether or not the author box is displayed in the article footer.|
+|`showDate`|boolean|`article.showDate`|Whether or not article dates are displayed.|
+|`showEdit`|boolean|`article.showEdit`|Whether or not the link to edit the article content should be displayed.|
 |`showHeadingAnchors`|boolean|`article.showHeadingAnchors`|Whether or not heading anchor links are displayed alongside headings within this article.|
 |`showPagination`|boolean|`article.showPagination`|Whether or not the next/previous article links are displayed in the article footer.|
 |`showReadingTime`|boolean|`article.showReadingTime`|Whether or not article reading times are displayed.|
+|`showSummary`|boolean|`list.showSummary`|Whether or not the article summary should be displayed on list pages.|
+|`summary`|string|_Auto generated using `summaryLength` (see [site configuration]({{< ref "configuration#site-configuration" >}}))_|When `showSummary` is enabled, this is the Markdown string to be used as the summary for this article.|
 |`xml`|boolean|`true` unless excluded by `sitemap.excludedKinds`|Whether or not this article is included in the generated `/sitemap.xml` file.|
 <!-- prettier-ignore-end -->