From 7285cac334916b850835342c9c8b1e3f1c5b9ea5 Mon Sep 17 00:00:00 2001
From: James Panther <4462786+jpanther@users.noreply.github.com>
Date: Sun, 15 Aug 2021 18:41:40 +1000
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20multiple=20homepage=20layouts?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 68 +++++++++++++++---
config/_default/params.toml | 18 +++--
exampleSite/config.toml | 8 ++-
exampleSite/content/_index.md | 6 +-
exampleSite/layouts/partials/home/custom.html | 33 +++++++++
exampleSite/static/img/author.jpg | Bin 0 -> 116976 bytes
images/home-page.jpg | Bin 0 -> 246440 bytes
images/home-profile-recent.jpg | Bin 0 -> 105595 bytes
images/home-profile.jpg | Bin 0 -> 79548 bytes
images/screenshot.png | Bin 371932 -> 1218668 bytes
images/tn.png | Bin 160502 -> 79383 bytes
layouts/_default/baseof.html | 2 +-
layouts/_default/single.html | 2 +-
layouts/index.html | 20 ++++--
layouts/partials/author-links.html | 16 +++++
layouts/partials/author.html | 17 +----
layouts/partials/header.html | 2 +-
layouts/partials/home/page.html | 8 +++
layouts/partials/home/profile.html | 21 ++++++
static/css/main.css | 2 +-
20 files changed, 176 insertions(+), 47 deletions(-)
create mode 100644 exampleSite/layouts/partials/home/custom.html
create mode 100644 exampleSite/static/img/author.jpg
create mode 100644 images/home-page.jpg
create mode 100644 images/home-profile-recent.jpg
create mode 100644 images/home-profile.jpg
create mode 100644 layouts/partials/author-links.html
create mode 100644 layouts/partials/home/page.html
create mode 100644 layouts/partials/home/profile.html
diff --git a/README.md b/README.md
index dcd92e60..54164053 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,7 @@ Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tail
- Fully responsive layout
- Dark mode (auto-switching based upon browser)
- Highly customisable configuration
+- Multiple homepage layouts
- Flexible with any content types, taxonomies and menus
- Diagrams and visualisations using Mermaid JS
- SVG icons from FontAwesome 5
@@ -44,9 +45,14 @@ Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tail
- [4. Set up your configuration files](#4-set-up-your-configuration-files)
- [Configuration](#configuration)
- [Getting started](#getting-started)
+ - [Homepage layout](#homepage-layout)
+ - [Page layout](#page-layout)
+ - [Profile layout](#profile-layout)
+ - [Custom layout](#custom-layout)
+ - [Recent articles](#recent-articles)
- [Organising content](#organising-content)
- [Parameters](#parameters)
- - [Front Matter](#front-matter)
+ - [Front matter](#front-matter)
- [Shortcodes](#shortcodes)
- [Alert](#alert)
- [Icon](#icon)
@@ -121,11 +127,11 @@ Refer to the Hugo docs for more information or read the next section to learn mo
Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.
-The theme ships with a default configuration that gets you up and running with a basic blog or static website. This default configuration can be found in the `themes/congo/config/_default/` folder.
+The theme ships with a default configuration that gets you up and running with a basic blog or static website.
> Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON as you wish.
-The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.
+The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs. If you followed the installation instructions above, you should adjust your theme configuration by modifying the files in the `config/_default/` folder of your Hugo project.
### Getting started
@@ -154,6 +160,46 @@ links = [
]
```
+### Homepage layout
+
+Congo provides a fully flexible homepage layout. There are two main templates to choose from with additional settings to adjust the design. Alternatively, you can also provide your own template and have complete control over the homepage content.
+
+The layout of the homepage is controlled by the `homepage.layout` setting in the `params.toml` configuration file. Additionally, all layouts have the option to include a listing of recent articles.
+
+#### Page layout
+
+The default layout is the page layout. It's simply a normal content page that displays your Markdown content. It's great for static websites and provides a lot of flexibility.
+
+
+
+To enable the page layout, set `homepage.layout = "page"` in the `params.toml` configuration file.
+
+#### Profile layout
+
+The profile layout is great for personal websites and blogs. It puts the author's details front and centre by providing an image and links to social profiles.
+
+The author information is provided in the `author.toml` configuration file. Additionally, any Markdown content that is provided in the homepage content will be placed below the author profile. This allows extra flexibility for displaying a bio or other custom content using shortcodes.
+
+
+
+To enable the profile layout, set `homepage.layout = "profile"` in the `params.toml` configuration file.
+
+#### Custom layout
+
+If the built-in homepage layouts aren't sufficient for your needs, you have the option to provide your own custom layout. This allows you to have total control over the page content and essentially gives you a blank slate to work with.
+
+To enable the custom layout, set `homepage.layout = "custom"` in the `params.toml` configuration file.
+
+With the configuration value set, create a new `custom.html` file and place it in `layouts/partials/home/custom.html`. Now whatever is in the `custom.html` file will be placed in the content area of the site homepage. You can use whatever HTML, Tailwind, or Hugo templating functions to define your layout.
+
+#### Recent articles
+
+All homepage layouts have the option of displaying recent articles below the main page content. To enable this, simply set the `homepage.showList` setting to `true` in the `params.toml` configuration file.
+
+
+
+The articles listed in this section are derived from the `homepage.listSections` setting which allows for whatever content types you are using on your website. For instance, if you had content sections for _posts_ and _projects_ you could set this setting to `["posts", "projects"]` and all the articles in these two sections would be used to populate the recent list. The theme expects this setting to be an array so if you only use one section for all your content, you should set this accordingly: `["blog"]`.
+
### Organising content
By default, Congo doesn't force you to use a particular content type. In doing so you are free to define your content as you wish. You might prefer _pages_ for a static site, _posts_ for a blog, or _projects_ for a portfolio.
@@ -195,23 +241,27 @@ Many of the article defaults here can be overridden on a per article basis by sp
|Name|Type|Default|Description|
| --- | --- | --- | --- |
+|`homepage.layout`|string|`"page"`|The layout of the homepage. Valid values are `page`, `profile` or `custom`. When set to `custom`, you must provide your own layout by creating a `/layouts/partials/home/custom.html` file.|
+|`homepage.showList`|boolean|`false`|Whether or not recent articles are listed on the homepage beneath the page content.|
+|`homepage.listSections`|array of strings|`["blog"]`|The sections of content to include in the recent list when `homepage.showList` is `true`.|
|`article.showDate`|boolean|`true`|Whether or not article dates are displayed.|
|`article.dateFormat`|string|`"2 January 2006"`|How article dates are formatted. Refer to the [Hugo docs](https://gohugo.io/functions/format/#gos-layout-string) for acceptable formats.|
-|`article.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.|
-|`article.showHeadingAnchors`|boolean|`true`|Whether or not heading anchor links are displayed alongside headings within articles.|
|`article.showAuthor`|boolean|`true`|Whether or not the author box is displayed in the article footer.|
+|`article.showDraftLabel`|boolean|`true`|Whether or not the draft indicator is shown next to articles when site is built with `--buildDrafts`.|
+|`article.showHeadingAnchors`|boolean|`true`|Whether or not heading anchor links are displayed alongside headings within articles.|
|`article.showPagination`|boolean|`true`|Whether or not the next/previous article links are displayed in the article footer.|
-|`taxonomy.showTermCount`|boolean|`true`|Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.|
+|`article.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.|
|`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](#analyticshtml) below 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.|
|`verification.pinterest`|string|_Not set_|The site verification string provided by Pinterest to be included in the site metadata.|
|`verification.yandex`|string|_Not set_|The site verification string provided by Yandex to be included in the site metadata.|
-|`fathomAnalytics.site`|string|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs](#analyticshtml) below 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.|
-## Front Matter
+## Front matter
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.
diff --git a/config/_default/params.toml b/config/_default/params.toml
index 7bd803b6..415e3301 100644
--- a/config/_default/params.toml
+++ b/config/_default/params.toml
@@ -4,13 +4,19 @@
#
# Refer to the README for more details about each of these parameters.
+[homepage]
+ layout = "page" # valid options: page, profile, custom
+ showList = false
+ listSections = ["blog"]
+
[article]
showDate = true
dateFormat = "2 January 2006"
- showReadingTime = true
- showHeadingAnchors = true
showAuthor = true
+ showDraftLabel = true
+ showHeadingAnchors = true
showPagination = true
+ showReadingTime = true
[taxonomy]
showTermCount = true
@@ -18,12 +24,12 @@
[sitemap]
excludedKinds = ["taxonomy", "term"]
+[fathomAnalytics]
+ # site = "ABC12345"
+ # domain = "llama.yoursite.com"
+
[verification]
# google = ""
# bing = ""
# pinterest = ""
# yandex = ""
-
-[fathomAnalytics]
- # site = "ABC12345"
- # domain = "llama.yoursite.com"
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 32347d02..400bf3f8 100755
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -13,8 +13,8 @@ languageCode = "en-AU"
title = "Congo"
[author]
- name = "Freddy Blogger"
- image = "https://i.pravatar.cc/150?img=11"
+ name = "Congo Profile"
+ image = "/img/author.jpg"
links = [
{ twitter = "https://twitter.com/" },
{ facebook = "https://facebook.com/" },
@@ -22,6 +22,10 @@ title = "Congo"
{ youtube = "https://youtube.com/" },
]
+[params.homepage]
+ layout = "custom"
+ showList = true
+
[[menu.main]]
name = "Blog"
pageRef = "blog"
diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md
index 06653c6f..f399bbab 100755
--- a/exampleSite/content/_index.md
+++ b/exampleSite/content/_index.md
@@ -1,5 +1,5 @@
---
-title: "Welcome to Congo! 🎉"
+title: "Welcome to Congo! :tada:"
description: "This is a demo of the Congo theme for Hugo"
---
@@ -7,8 +7,6 @@ description: "This is a demo of the Congo theme for Hugo"
A simple, lightweight theme for Hugo built with Tailwind CSS.
{{< /lead >}}
-This is the homepage. It's just plain Markdown content and can render whatever you wish.
-
-Perhaps you'll link to an [about](/about/) page, or direct people to check out your [blog posts](/blog/). It's really up to you.
+This is the homepage. It's just plain Markdown content and can render whatever you wish. Perhaps you'll link to an [about](/about/) page, or direct people to check out your [blog posts](/blog/). It's really up to you.
{{< figure src="mountains.jpg" caption="Photo by [Anna Scarfiello](https://unsplash.com/@little_anne?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText)." >}}
diff --git a/exampleSite/layouts/partials/home/custom.html b/exampleSite/layouts/partials/home/custom.html
new file mode 100644
index 00000000..56868a64
--- /dev/null
+++ b/exampleSite/layouts/partials/home/custom.html
@@ -0,0 +1,33 @@
+
+
+
+
+ {{ partial "icon.html" "exclamation-triangle" }}
+
+
+ This is a demo of the `page` homepage layout.
+
+
+