updated docs for v1 and polished some minor fixes across the code

This commit is contained in:
Nuno Coração
2022-09-13 00:49:15 +01:00
parent 925155fb9c
commit 002db90080
446 changed files with 1271 additions and 2281 deletions
Binary file not shown.

Before

Width:  |  Height:  |  Size: 241 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

@@ -2,12 +2,12 @@
title: "Homepage Layout"
date: 2020-08-13
draft: false
description: "Configuring the homepage layout in the Congo theme."
description: "Configuring the homepage layout in the Blowfish theme."
slug: "homepage-layout"
tags: ["homepage", "layouts", "docs"]
---
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.
Blowfish 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](#recent-articles).
@@ -15,7 +15,7 @@ The layout of the homepage is controlled by the `homepage.layout` setting in the
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.
![Screenshot of homepage layout](home-page.jpg)
![Screenshot of homepage layout](home-page.png)
To enable the page layout, set `homepage.layout = "page"` in the `params.toml` configuration file.
@@ -23,7 +23,7 @@ To enable the page layout, set `homepage.layout = "page"` in the `params.toml` c
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.
![Screenshot of profile layout](home-profile.jpg)
![Screenshot of profile layout](home-profile.png)
The author information is provided in the languages configuration file. Refer to the [Getting Started]({{< ref "getting-started" >}}) and [Language Configuration]({{< ref "configuration##language-and-i18n" >}}) sections for parameter details.
@@ -41,12 +41,12 @@ With the configuration value set, create a new `custom.html` file and place it i
To include [recent articles](#recent-articles) on the custom layout, use the `recent-articles.html` partial.
As an example, the [homepage]({{< ref "/" >}}) on this site uses the custom layout to allow toggling between the profile and page layouts. Visit the [GitHub repo](https://github.com/jpanther/congo/blob/dev/exampleSite/layouts/partials/home/custom.html) to see how it works.
As an example, the [homepage]({{< ref "/" >}}) on this site uses the custom layout to allow toggling between the profile and page layouts. Visit the [GitHub repo](https://github.com/nunocoracao/blowfish/blob/main/exampleSite/layouts/partials/home/custom.html) to see how it works.
## Recent articles
All homepage layouts have the option of displaying recent articles below the main page content. To enable this, simply set the `homepage.showRecent` setting to `true` in the `params.toml` configuration file.
![Profile layout with recent articles](home-profile-list.jpg)
![Profile layout with recent articles](home-profile-list.png)
The articles listed in this section are derived from the `mainSections` 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"]`.