From 8671712a8c6ab306316aa87da2374b73be017f05 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Sat, 18 Dec 2021 09:06:59 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20changelog=20and=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 4 ++++ exampleSite/content/docs/configuration.md | 1 + exampleSite/content/docs/front-matter.md | 3 ++- 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eeac1727..f6ec3852 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] +### Added + +- Option to display article word counts ([#57](https://github.com/jpanther/congo/pull/57)) + ## [1.5.3] - 2021-11-18 ### Changed diff --git a/exampleSite/content/docs/configuration.md b/exampleSite/content/docs/configuration.md index 5113c5d1..3b1e0f0d 100644 --- a/exampleSite/content/docs/configuration.md +++ b/exampleSite/content/docs/configuration.md @@ -76,6 +76,7 @@ Many of the article defaults here can be overridden on a per article basis by sp |`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.| |`article.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.| +|`article.showWordCount`|boolean|`false`|Whether or not article word counts 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).| diff --git a/exampleSite/content/docs/front-matter.md b/exampleSite/content/docs/front-matter.md index 9634c34d..e543ca88 100644 --- a/exampleSite/content/docs/front-matter.md +++ b/exampleSite/content/docs/front-matter.md @@ -27,7 +27,8 @@ Front matter parameter default values are inherited from the theme's [base confi |`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.| +|`showReadingTime`|boolean|`article.showReadingTime`|Whether or not the article reading time is displayed.| +|`showWordCount`|boolean|`article.showWordCount`|Whether or not the article word count is 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.|