From 91d2597bdf1a04a7dc9600c67f67ca0c1f70b317 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Wed, 29 Sep 2021 10:39:29 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Fix=20documentation=20typos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- exampleSite/content/docs/advanced-customisation.md | 4 ++-- exampleSite/content/docs/configuration.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/exampleSite/content/docs/advanced-customisation.md b/exampleSite/content/docs/advanced-customisation.md index f76ad9ad..f1cd88ec 100644 --- a/exampleSite/content/docs/advanced-customisation.md +++ b/exampleSite/content/docs/advanced-customisation.md @@ -21,7 +21,7 @@ Use one of the existing theme stylesheets as a template. You are free to define ## Overriding the stylesheet -Sometimes you need to add a custom style to style your own HTML elements. Congo provides for this scenario by allowing you to overrid the default styles in your own CSS stylesheet. Simply create a `custom.css` file in your project's `assets/css/` folder. +Sometimes you need to add a custom style to style your own HTML elements. Congo provides for this scenario by allowing you to override the default styles in your own CSS stylesheet. Simply create a `custom.css` file in your project's `assets/css/` folder. The `custom.css` file will be minified by Hugo and loaded automatically after all the other theme styles which means anything in your custom file will take precedence over the defaults. @@ -54,7 +54,7 @@ npm run dev This will automatically output a CSS file to `/themes/congo/assets/css/compiled/main.css`. {{< alert >}} -**Note:** You should make manual edits to the compiled CSS file. +**Note:** You should not make manual edits to the compiled CSS file. {{< /alert >}} Now whenever you make a change, the CSS files will be rebuilt automatically. This mode is useful to run when using `hugo server` to preview your site during development. Asset files will be minified by Hugo at site build time. diff --git a/exampleSite/content/docs/configuration.md b/exampleSite/content/docs/configuration.md index f52c1df6..1e6bd5cb 100644 --- a/exampleSite/content/docs/configuration.md +++ b/exampleSite/content/docs/configuration.md @@ -54,7 +54,7 @@ Many of the article defaults here can be overridden on a per article basis by sp |Name|Type|Default|Description| | --- | --- | --- | --- | -|`colorScheme`|string|`"congo"`|The theme colour scheme to use. Valid values are `congo` (default), `avocado`, `ocean` and `fire`.| +|`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.| |`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.|