congo/CHANGELOG.md

# Changelog

All notable changes to Congo will be documented in this file. Things that need attention when upgrading from a prior version are marked ⚠️.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- German translation ([#27](https://github.com/jpanther/congo/pull/27))

### Fixed

- Article pagination link spacing ([#26](https://github.com/jpanther/congo/pull/26))
- Minor icon style issues

## [1.5.1] - 2021-11-04

### Fixed

- Hugo failing to build site when deploying as a module

## [1.5.0] - 2021-11-04

### Added

- Chart.js support using `chart` shortcode
- KaTeX support using `katex` shortcode
- Dark mode toggle with new theme parameters for managing light/dark appearance
- French translation ([#18](https://github.com/jpanther/congo/pull/18))
- Author bio in article footer
- Grouping by year can now be specificed in front matter on list pages

### Changed

- Site name, author and menus will now render Markdown and Emoji
- Bundled Mermaid for better vendor dependency management
- Mermaid diagrams are now themed to match the configured colour scheme
- Upgrade to Tailwind v2.2.19

### Fixed

- Site logo image dimensions are unconstrained ([#19](https://github.com/jpanther/congo/issues/19))
- Article summary styled incorrectly in dark mode
- Links containing `code` blocks styled incorrectly

## [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

- Site logo support
- Chinese translation ([#2](https://github.com/jpanther/congo/pull/2))

### Changed

- Upgrade to Tailwind v2.2.16

## [1.2.1] - 2021-08-26

### Added

- New `robots` parameter to add metadata to guide robots on how to handle specific content

### Changed

- URLs are relative by default which allows the theme to be more flexible in different deployment scenarios

### Fixed

- Missing dark style for group subheadings on article listings
- Fathom Analytics script included twice when using custom domain
- Recent heading on homepage profile layout misaligned

## [1.2.0] - 2021-08-22

### Added

- Multiple colour schemes
- Edit links on article pages
- Icons for Foursquare and Pinterest
- Asset fingerprinting and SRI
- CSS minification for custom stylesheets

### Changed

- Static assets are now managed through Hugo Pipelines

### Fixed

- Minor style issue with `button` shortcode
- Hugo Modules would fail when using default theme config file
- Some content not centred correctly on the profile homepage layout
- Some links missing the correct styles when in Firefox
- `externalUrl` front matter not working on some list pages

## [1.1.1] - 2021-08-19

### Fixed

- Hotfix for exampleSite and GitHub configuration

## [1.1.0] - 2021-08-18

### Added

- Breadcrumbs
- i18n support
- Recent articles partial
- CSS transitions
- Hugo module support
- JSON-LD structured metadata

### Changed

- ⚠️ Renamed parameter: `homepage.showList` -> `homepage.showRecent`
- ⚠️ Renamed parameter: `homepage.listSections` -> `mainSections`
- ⚠️ Consolidated author configuration parameters into `config.toml`
- General style tweaks to enhance design consistency

### Fixed

- URLs being incorrect in some cases when the site is deployed in a subfolder

## [1.0.0] - 2021-08-16

### Added

- Built with Tailwind CSS JIT for minified stylesheets without any excess code
- Fully responsive layout
- Dark mode (auto-switching based upon browser)
- Highly customisable configuration
- Multiple homepage layouts
- Flexible with any content types, taxonomies and menus
- Ability to link to posts on third-party websites
- Diagrams and visualisations using Mermaid JS
- SVG icons from FontAwesome 5
- Heading anchors, Buttons, Badges and more
- HTML and Emoji support in articles
- SEO friendly with links for sharing to social media
- RSS feeds
- Fathom Analytics and Google Analytics support
- Favicons support
- Comments support
- Advanced customisation using simple Tailwind colour definitions and styles
- Fully documented

[unreleased]: https://github.com/jpanther/Congo/compare/v1.5.1...HEAD
[1.5.1]: https://github.com/jpanther/Congo/compare/v1.5.0...v1.5.1
[1.5.0]: https://github.com/jpanther/Congo/compare/v1.4.0...v1.5.0
[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
[1.1.1]: https://github.com/jpanther/congo/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/jpanther/congo/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/jpanther/congo/releases/tag/v1.0.0
📝 Add Changelog 2021-08-17 00:55:25 +00:00			`# Changelog`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
🔨 Add changelog and version updates to release.sh 2021-08-22 06:55:10 +00:00			`All notable changes to Congo will be documented in this file. Things that need attention when upgrading from a prior version are marked ⚠️.`
♻️ Move homepage recent articles to partial 2021-08-18 04:35:54 +00:00
💄 Style updates to enhance design consistency 2021-08-18 02:54:18 +00:00			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`
📝 Add Changelog 2021-08-17 00:55:25 +00:00
💄 Fix style issue with button shortcode 2021-08-19 04:09:43 +00:00			`## [Unreleased]`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
📝 Update changelog 2021-11-07 23:34:36 +00:00			`### Added`

			`- German translation ([#27](https://github.com/jpanther/congo/pull/27))`

💄 Only output icon styles if there is an icon 2021-11-06 02:05:29 +00:00			`### Fixed`

📝 Update changelog 2021-11-06 03:49:55 +00:00			`- Article pagination link spacing ([#26](https://github.com/jpanther/congo/pull/26))`
			`- Minor icon style issues`
💄 Only output icon styles if there is an icon 2021-11-06 02:05:29 +00:00
🔨 Preparing release v1.5.1 2021-11-04 03:22:21 +00:00			`## [1.5.1] - 2021-11-04`

🚑 Rename vendor directory to lib 2021-11-04 03:19:02 +00:00			`### Fixed`

			`- Hugo failing to build site when deploying as a module`

🔨 Preparing release v1.5.0 2021-11-04 00:06:28 +00:00			`## [1.5.0] - 2021-11-04`

📝 Update changelog 2021-10-26 22:52:45 +00:00			`### Added`

✨ Add chart shortcode 2021-10-28 04:32:27 +00:00			- Chart.js support using `chart` shortcode
✨ Add KaTeX and katex shortcode 2021-11-03 23:11:48 +00:00			- KaTeX support using `katex` shortcode
✨ Add dark mode toggle 2021-10-29 03:51:49 +00:00			`- Dark mode toggle with new theme parameters for managing light/dark appearance`
📝 Update changelog 2021-10-26 22:52:45 +00:00			`- French translation ([#18](https://github.com/jpanther/congo/pull/18))`
✨ Add author bio to article footer 2021-11-03 23:54:47 +00:00			`- Author bio in article footer`
🚸 Add groupByYear to front matter 2021-10-26 23:48:29 +00:00			`- Grouping by year can now be specificed in front matter on list pages`
📝 Update changelog 2021-10-26 22:52:45 +00:00
💄 Add Markdown and Emoji support to parameters 2021-10-26 23:34:50 +00:00			`### Changed`

			`- Site name, author and menus will now render Markdown and Emoji`
➕ Add Mermaid as bundled dependency 2021-10-28 01:39:34 +00:00			`- Bundled Mermaid for better vendor dependency management`
💄 Add Mermaid theming to match colour scheme 2021-10-28 04:01:19 +00:00			`- Mermaid diagrams are now themed to match the configured colour scheme`
⬆️ Upgrade to Tailwind v2.2.19 2021-11-04 00:02:36 +00:00			`- Upgrade to Tailwind v2.2.19`
💄 Add Markdown and Emoji support to parameters 2021-10-26 23:34:50 +00:00
🐛 Fix site logo image dimensions unconstrained Closes #19 2021-10-28 06:19:53 +00:00			`### Fixed`

			`- Site logo image dimensions are unconstrained ([#19](https://github.com/jpanther/congo/issues/19))`
🐛 Fix article summary style in dark mode 2021-10-29 03:54:46 +00:00			`- Article summary styled incorrectly in dark mode`
🐛 Fix code block style within links 2021-11-03 22:56:30 +00:00			- Links containing `code` blocks styled incorrectly
🐛 Fix site logo image dimensions unconstrained Closes #19 2021-10-28 06:19:53 +00:00
🔨 Preparing release v1.4.0 2021-10-20 03:56:47 +00:00			`## [1.4.0] - 2021-10-20`

📝 Update changelog 2021-10-18 02:08:36 +00:00			`### Added`

✨ Add footer menu 2021-10-19 04:45:11 +00:00			`- Footer menu`
✨ Add support for article summaries 2021-10-19 06:04:42 +00:00			`- Article summary support`
📝 Update changelog 2021-10-18 02:08:36 +00:00			`- Slate colour scheme ([#9](https://github.com/jpanther/congo/pull/9))`
			`- Icons for ORCID and ResearchGate ([#9](https://github.com/jpanther/congo/pull/9))`
✨ Add Pinterest sharing links 2021-10-20 00:07:55 +00:00			`- Pinterest sharing links`
🚸 Add sharing links to front matter 2021-10-19 23:44:57 +00:00			`- Sharing links can now be specified in front matter`
📝 Update changelog 2021-10-18 02:08:36 +00:00
🚸 Make main menu optional 2021-10-19 04:44:23 +00:00			`### Changed`

			`- Main menu is now optional`
⬆️ Upgrade to Mermaid v8.13.3 2021-10-19 23:21:44 +00:00			`- Upgrade to Mermaid v8.13.3`
⬆️ Upgrade to Tailwind v2.2.17 2021-10-20 03:47:40 +00:00			`- Upgrade to Tailwind v2.2.17`
🚸 Make main menu optional 2021-10-19 04:44:23 +00:00
🐛 Fix logo not linked to home page Closes #13 2021-10-19 06:33:18 +00:00			`### Fixed`

			`- Site logo not linked to home page ([#13](https://github.com/jpanther/congo/issues/13))`

🔨 Preparing release v1.3.0 2021-09-29 00:56:22 +00:00			`## [1.3.0] - 2021-09-29`

📝 Update changelog 2021-09-20 05:17:43 +00:00			`### Added`

✨ Add option to add a site logo 2021-09-22 02:24:46 +00:00			`- Site logo support`
📝 Update changelog 2021-09-20 05:17:43 +00:00			`- Chinese translation ([#2](https://github.com/jpanther/congo/pull/2))`

⬆️ Upgrade to Tailwind v2.2.16 2021-09-29 00:55:03 +00:00			`### Changed`

			`- Upgrade to Tailwind v2.2.16`

🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00			`## [1.2.1] - 2021-08-26`

✨ Add `robots` parameters 2021-08-26 00:07:37 +00:00			`### Added`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add `robots` parameters 2021-08-26 00:07:37 +00:00			- New `robots` parameter to add metadata to guide robots on how to handle specific content

			`### Changed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add `robots` parameters 2021-08-26 00:07:37 +00:00			`- URLs are relative by default which allows the theme to be more flexible in different deployment scenarios`

🩹 Add dark style to group subheadings 2021-08-22 23:49:59 +00:00			`### Fixed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
🩹 Add dark style to group subheadings 2021-08-22 23:49:59 +00:00			`- Missing dark style for group subheadings on article listings`
🐛 Fix Fathom Analytics script included twice 2021-08-25 03:31:53 +00:00			`- Fathom Analytics script included twice when using custom domain`
💄 Fix recent header alignment on profile layout 2021-08-25 06:25:45 +00:00			`- Recent heading on homepage profile layout misaligned`
💄 Fix style issue with button shortcode 2021-08-19 04:09:43 +00:00
🔨 Preparing release v1.2.0 2021-08-22 07:24:17 +00:00			`## [1.2.0] - 2021-08-22`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
🍱 Add icons for Foursquare and Pinterest 2021-08-19 07:28:56 +00:00			`### Added`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add multiple colour schemes 2021-08-20 07:02:08 +00:00			`- Multiple colour schemes`
✨ Add edit links on article pages 2021-08-21 01:42:40 +00:00			`- Edit links on article pages`
🍱 Add icons for Foursquare and Pinterest 2021-08-19 07:28:56 +00:00			`- Icons for Foursquare and Pinterest`
✨ Add asset fingerprinting and SRI 2021-08-21 02:20:29 +00:00			`- Asset fingerprinting and SRI`
			`- CSS minification for custom stylesheets`

			`### Changed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add asset fingerprinting and SRI 2021-08-21 02:20:29 +00:00			`- Static assets are now managed through Hugo Pipelines`
🍱 Add icons for Foursquare and Pinterest 2021-08-19 07:28:56 +00:00
💄 Fix style issue with button shortcode 2021-08-19 04:09:43 +00:00			`### Fixed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
📝 Add instructions for Hugo Modules installation 2021-08-19 04:40:57 +00:00			- Minor style issue with `button` shortcode
			`- Hugo Modules would fail when using default theme config file`
💄 Fix some content not centred on profile layout 2021-08-19 06:43:45 +00:00			`- Some content not centred correctly on the profile homepage layout`
💄 Fix links missing some styles in Firefox 2021-08-20 03:56:45 +00:00			`- Some links missing the correct styles when in Firefox`
🐛 Fix externalUrl not working on some list pages 2021-08-22 06:58:25 +00:00			- `externalUrl` front matter not working on some list pages
💄 Fix style issue with button shortcode 2021-08-19 04:09:43 +00:00
📝 Fix changelog dates 2021-10-20 03:56:25 +00:00			`## [1.1.1] - 2021-08-19`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
📝 Update changelog for release 2021-08-19 03:00:59 +00:00			`### Fixed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
📝 Update changelog for release 2021-08-19 03:00:59 +00:00			`- Hotfix for exampleSite and GitHub configuration`

📝 Fix changelog dates 2021-10-20 03:56:25 +00:00			`## [1.1.0] - 2021-08-18`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add i18n support 2021-08-17 06:48:08 +00:00			`### Added`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add breadcrumbs 2021-08-18 00:08:06 +00:00			`- Breadcrumbs`
✨ Add i18n support 2021-08-17 06:48:08 +00:00			`- i18n support`
♻️ Move homepage recent articles to partial 2021-08-18 04:35:54 +00:00			`- Recent articles partial`
💄 Style updates to enhance design consistency 2021-08-18 02:54:18 +00:00			`- CSS transitions`
✨ Add Hugo module support 2021-08-18 06:01:53 +00:00			`- Hugo module support`
✨ Add JSON-LD structured metadata 2021-08-18 07:06:14 +00:00			`- JSON-LD structured metadata`
✨ Add i18n support 2021-08-17 06:48:08 +00:00
🔧 Consolidate author configuration options 2021-08-17 05:35:04 +00:00			`### Changed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add Hugo module support 2021-08-18 06:01:53 +00:00			- ⚠️ Renamed parameter: `homepage.showList` -> `homepage.showRecent`
✨ Add JSON-LD structured metadata 2021-08-18 07:06:14 +00:00			- ⚠️ Renamed parameter: `homepage.listSections` -> `mainSections`
✨ Add Hugo module support 2021-08-18 06:01:53 +00:00			- ⚠️ Consolidated author configuration parameters into `config.toml`
💄 Style updates to enhance design consistency 2021-08-18 02:54:18 +00:00			`- General style tweaks to enhance design consistency`
🔧 Consolidate author configuration options 2021-08-17 05:35:04 +00:00
🐛 Fix incorrect URL when deploying to a subfolder 2021-08-17 01:03:22 +00:00			`### Fixed`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
✨ Add i18n support 2021-08-17 06:48:08 +00:00			`- URLs being incorrect in some cases when the site is deployed in a subfolder`
🐛 Fix incorrect URL when deploying to a subfolder 2021-08-17 01:03:22 +00:00
📝 Fix changelog dates 2021-10-20 03:56:25 +00:00			`## [1.0.0] - 2021-08-16`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
🔨 Add changelog and version updates to release.sh 2021-08-22 06:55:10 +00:00			`### Added`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00
📝 Add Changelog 2021-08-17 00:55:25 +00:00			`- Built with Tailwind CSS JIT for minified stylesheets without any excess code`
			`- Fully responsive layout`
			`- Dark mode (auto-switching based upon browser)`
			`- Highly customisable configuration`
			`- Multiple homepage layouts`
			`- Flexible with any content types, taxonomies and menus`
			`- Ability to link to posts on third-party websites`
			`- Diagrams and visualisations using Mermaid JS`
			`- SVG icons from FontAwesome 5`
			`- Heading anchors, Buttons, Badges and more`
			`- HTML and Emoji support in articles`
			`- SEO friendly with links for sharing to social media`
			`- RSS feeds`
			`- Fathom Analytics and Google Analytics support`
			`- Favicons support`
			`- Comments support`
			`- Advanced customisation using simple Tailwind colour definitions and styles`
			`- Fully documented`

🔨 Preparing release v1.5.1 2021-11-04 03:22:21 +00:00			`[unreleased]: https://github.com/jpanther/Congo/compare/v1.5.1...HEAD`
			`[1.5.1]: https://github.com/jpanther/Congo/compare/v1.5.0...v1.5.1`
🔨 Preparing release v1.5.0 2021-11-04 00:06:28 +00:00			`[1.5.0]: https://github.com/jpanther/Congo/compare/v1.4.0...v1.5.0`
🔨 Preparing release v1.4.0 2021-10-20 03:56:47 +00:00			`[1.4.0]: https://github.com/jpanther/Congo/compare/v1.3.0...v1.4.0`
🔨 Preparing release v1.3.0 2021-09-29 00:56:22 +00:00			`[1.3.0]: https://github.com/jpanther/Congo/compare/v1.2.1...v1.3.0`
🔨 Preparing release v1.2.1 2021-08-26 00:18:35 +00:00			`[1.2.1]: https://github.com/jpanther/Congo/compare/v1.2.0...v1.2.1`
🔨 Preparing release v1.2.0 2021-08-22 07:24:17 +00:00			`[1.2.0]: https://github.com/jpanther/Congo/compare/v1.1.1...v1.2.0`
📝 Update changelog for release 2021-08-19 03:00:59 +00:00			`[1.1.1]: https://github.com/jpanther/congo/compare/v1.1.0...v1.1.1`
🩹 Standardise project URLs to be lowercase 2021-08-18 23:36:00 +00:00			`[1.1.0]: https://github.com/jpanther/congo/compare/v1.0.0...v1.1.0`
			`[1.0.0]: https://github.com/jpanther/congo/releases/tag/v1.0.0`