🔖 Release v2.7.0

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -5,43 +5,57 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this bug report! Before proceeding, please check that a similar issue has not already been reported. [View open issues](https://github.com/jpanther/congo/issues)
+        Thanks for taking the time to fill out this bug report!
+
+        Before proceeding, please ensure the issue you're reporting is:
+          - not caused by local customisations in your project
+          - reproducible using the latest stable release of the theme
+          - not already covered by an open issue ([check open issues](https://github.com/jpanther/congo/issues))
+          - not a general question or feature request (use [GitHub Discussions](https://github.com/jpanther/congo/discussions) instead)
+
   - type: textarea
-    id: what-happened
+    id: issue-description
     attributes:
-      label: What happened?
-      description: Describe the issue and how to reproduce it, including what you expected to happen.
+      label: Issue description
+      description: Describe the issue and how to reproduce it, including what you expected to happen. Be as detailed as possible, particularly if the issue only appears under a specific configuration.
     validations:
       required: true
   - type: input
     id: theme-version
     attributes:
       label: Theme version
-      description: What version of the theme are you using?
-      placeholder: eg. v1.1.0
+      description: What version of the theme are you using? If you have not tested this issue with the latest theme release, please do so before submitting a bug report.
+      placeholder: eg. v2.6.0
     validations:
       required: true
   - type: input
     id: hugo-version
     attributes:
       label: Hugo version
-      description: What version of Hugo are you using?
-      placeholder: eg. v0.86.1
+      description: What version of Hugo are you using? Please provide the output of the `hugo version` command.
+      placeholder: eg. hugo v0.114.0+extended darwin/arm64
     validations:
       required: true
   - type: dropdown
     id: browsers
     attributes:
-      label: What browsers are you seeing the problem on?
+      label: Which browser rendering engines are you seeing the problem on?
+      description: Select any that you have tested. This is particularly important for CSS issue reports.
       multiple: true
       options:
-        - Firefox
-        - Chrome
-        - Safari
-        - Microsoft Edge
+        - Chromium (Google Chrome, Microsoft Edge, Brave, Vivaldi, Opera, etc.)
+        - Firefox (Mozilla Firefox)
+        - WebKit (Safari)
+        - Other (Please include details in the issue description)
+  - type: input
+    id: sample-url
+    attributes:
+      label: URL to sample repository or website
+      description: If you have a repository or deployed Hugo website that demonstrates this issue, please provide the URL.
+      placeholder: https://github.com/jpanther/congo
   - type: textarea
     id: logs
     attributes:
-      label: Relevant Hugo log output
-      description: Please copy and paste any relevant Hugo log output. This will be automatically formatted into code, so no need for backticks.
-      render: shell
+      label: Hugo output or build error messages
+      description: Please copy and paste any relevant log output from Hugo or your build system. This will be automatically formatted into code, so no need for backticks.
+      render: bash

.github/workflows/build-theme.yml

@@ -8,44 +8,44 @@ jobs:
     if: ${{ github.actor == 'dependabot[bot]' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: "${{ github.head_ref }}"
       - name: Install dependencies and Build Theme
         uses: actions/setup-node@v3
       - run: npm install
       - run: npm run assets
       - name: Commit and push Chart.js changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: "${{ github.head_ref }}"
           push_options: "--dry-run"
           file_pattern: "assets/lib/chart/*"
           commit_message: "📦 Update packaged ChartJS"
       - name: Commit Fuse changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: "${{ github.head_ref }}"
           push_options: "--dry-run"
           file_pattern: "assets/lib/fuse/*"
           commit_message: "📦 Update packaged FuseJS"
       - name: Commit KaTeX changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: "${{ github.head_ref }}"
           push_options: "--dry-run"
           file_pattern: "assets/lib/katex/*"
           commit_message: "📦 Update packaged KaTeX"
       - name: Commit Mermaid changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: "${{ github.head_ref }}"
           push_options: "--dry-run"
           file_pattern: "assets/lib/mermaid/*"
           commit_message: "📦 Update packaged Mermaid"
       - run: npm run build
       - name: Commit CSS changes
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           branch: "${{ github.head_ref }}"
           push_options: "--dry-run"

.github/workflows/gh-pages.yml

@@ -13,7 +13,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0

.github/workflows/stale.yml

@@ -12,8 +12,8 @@ jobs:
     steps:
       - uses: actions/stale@v8
         with:
-          days-before-stale: 30
-          days-before-close: 14
+          days-before-stale: 120
+          days-before-close: 30
           stale-issue-label: "stale"
           exempt-issue-labels: "wip"
           stale-pr-label: "stale"
@@ -23,10 +23,10 @@ jobs:
 
             If you are still experiencing this issue, please review the issue history and add a reply with any requested and/or additional information in order to keep the issue open.
 
-            This issue will automactically close in 14 days if no further activity occurs.
+            This issue will automatically close in 30 days if no further activity occurs.
           stale-pr-message: >
             This pull request has been automatically marked as stale because it has not had any recent activity.
 
             Please review the PR history and add a reply with any requested information. If no information has been requested, it may be that this contribution does not fit with the project objectives, or does not adhere to the [contributing guidelines](https://github.com/jpanther/congo/blob/dev/CONTRIBUTING.md). If this is in error, please add a reply with further details.
 
-            This PR will automactically close in 14 days if no further activity occurs.
+            This PR will automatically close in 30 days if no further activity occurs.

.github/workflows/test-build.yml

@@ -10,7 +10,7 @@ jobs:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0

CHANGELOG.md

@@ -6,6 +6,48 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [2.7.0] - 2023-10-23
+
+### Added
+
+- New portable locale picker that can be placed in any menu using the `locale` action ([#583](https://github.com/jpanther/congo/issues/583))
+- New icons for `chevron-down`, `chevron-up`, `globe` and `translate`
+- Plausible Analytics support ([#584](https://github.com/jpanther/congo/pull/584))
+- Spanish translation of example site samples ([#606](https://github.com/jpanther/congo/pull/606))
+- Japanese translation of docs and example site ([#618](https://github.com/jpanther/congo/pull/618))
+- German translation of example site ([#631](https://github.com/jpanther/congo/pull/631))
+- New icons - `coffee` and `x-twitter` ([#669](https://github.com/jpanther/congo/pull/669))
+
+### Changed
+
+- ⚠️ Renamed the `params.rtl` language parameter to `languageDirection` as this is now supported by Hugo ([#583](https://github.com/jpanther/congo/issues/583))
+- Robots.txt file now allows all by default without concern for whether the environment is set to production ([#620](https://github.com/jpanther/congo/pull/620))
+- Refactored the `head.html` partial to improve perceived performance on page load
+- Upgrade to Mermaid v10.5.1 ([#577](https://github.com/jpanther/congo/pull/577), [#582](https://github.com/jpanther/congo/pull/582), [#626](https://github.com/jpanther/congo/pull/626), [#638](https://github.com/jpanther/congo/pull/638), [#663](https://github.com/jpanther/congo/pull/663), [#674](https://github.com/jpanther/congo/pull/674))
+- Upgrade to KaTeX v0.16.9 ([#590](https://github.com/jpanther/congo/pull/590), [#664](https://github.com/jpanther/congo/pull/664))
+- Upgrade to Tailwind v3.3.3 ([#602](https://github.com/jpanther/congo/pull/602))
+- Upgrade to ChartJS v4.3.3 ([#616](https://github.com/jpanther/congo/pull/616), [#627](https://github.com/jpanther/congo/pull/627), [#635](https://github.com/jpanther/congo/pull/635))
+- Upgrade to Typography v0.5.10 ([#641](https://github.com/jpanther/congo/pull/641))
+
+### Fixed
+
+- Prominent images in content and site layout are lazy loaded ([#591](https://github.com/jpanther/congo/issues/591))
+- TypeError is output to console when viewing leaf pages ([#596](https://github.com/jpanther/congo/issues/596))
+- URL to Congo project in footer used deprecated git.io short link ([#605](https://github.com/jpanther/congo/issues/605))
+- Various typos in the docs and example site ([#608](https://github.com/jpanther/congo/pull/608), [#609](https://github.com/jpanther/congo/pull/609), [#613](https://github.com/jpanther/congo/pull/613))
+- Incorrect `render` value is used in the 'external' archetype ([#630](https://github.com/jpanther/congo/pull/630))
+- Images are missing `width` and `height` attributes ([#645](https://github.com/jpanther/congo/pull/645))
+- Extended head partial does not include page context ([#658](https://github.com/jpanther/congo/pull/658))
+- Taxonomy tags aren't padded when wrapping onto a new line ([#671](https://github.com/jpanther/congo/pull/671))
+- Minor CSS improvements, mainly relating to RTL styling
+- Minor typos
+
+### Removed
+
+- Locales no longer appear next to the site name/logo as they are now part of the menu system ([#583](https://github.com/jpanther/congo/issues/583))
+- Language parameters `isoCode` and `displayName` are no longer supported ([#583](https://github.com/jpanther/congo/issues/583))
+- Meta `content-language` tag as it was not conveying the intended data (which is already included via the HTML `lang` attribute)
+
 ## [2.6.1] - 2023-06-04
 
 ### Changed
@@ -267,7 +309,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-- Breadcrumb display can now be can now be specificed in front matter for articles and list pages
+- Breadcrumb display can now be can now be specified in front matter for articles and list pages
 - Italian translation ([#209](https://github.com/jpanther/congo/pull/209))
 
 ### Changed
@@ -567,7 +609,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - 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
+- Grouping by year can now be specified in front matter on list pages
 
 ### Changed
 
@@ -703,7 +745,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Advanced customisation using simple Tailwind colour definitions and styles
 - Fully documented
 
-[Unreleased]: https://github.com/jpanther/congo/compare/v2.6.1...HEAD
+[Unreleased]: https://github.com/jpanther/congo/compare/v2.7.0...HEAD
+[2.7.0]: https://github.com/jpanther/congo/compare/v2.6.1...v2.7.0
 [2.6.1]: https://github.com/jpanther/congo/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/jpanther/congo/compare/v2.5.4...v2.6.0
 [2.5.4]: https://github.com/jpanther/congo/compare/v2.5.3...v2.5.4

CONTRIBUTING.md

@@ -35,9 +35,9 @@
 - Indent using 2 spaces (soft tabs).
 - Put spaces between list items (ie. `[1, 2, 3]`, not `[1,2,3]`), around operators (ie. `1 + 1`, not `1+1`) and inside go templating tags (ie. `{{< alert >}}`, not `{{<alert>}}`).
 - Avoid code reuse in templates by extracting components into partials.
-- Layout code in a logical manner that prioritises readibility.
+- Layout code in a logical manner that prioritises readability.
 - Add comments when the intent of the code isn't immediately apparent or to break up large blocks of logic.
-- Use relative paths to assets without including the preceeding slash but, when referring to a folder, including a trailing slash (ie. `static/img/`, not `/static/img/` or `/static/img`).
+- Use relative paths to assets without including the preceding slash but, when referring to a folder, including a trailing slash (ie. `static/img/`, not `/static/img/` or `/static/img`).
 - Any static text must be referenced using the `i18n` methods and included in the localisation assets.
 - Commit often, preferring incremental changes rather than bundling everything into a single, large commit.
 

README.md

@@ -17,7 +17,7 @@ Congo is designed to be a powerful, lightweight theme for [Hugo](https://gohugo.
 - Highly customisable configuration
 - Multiple homepage layouts
 - Flexible with any content types, taxonomies and menus
-- Multilingual content support inlcuding support for RTL languages
+- Multilingual content support including support for RTL languages
 - Ability to link to posts on third-party websites
 - Client-side site search powered by Fuse.js
 - Diagrams and visualisations using Mermaid

archetypes/external.md

@@ -5,6 +5,5 @@ externalUrl: ""
 summary: ""
 showReadingTime: false
 _build:
-  render: "false"
-  list: "local"
+  render: "never"
 ---