🔀 Merge branch 'dev' into stable

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,47 @@
+name: 🐛 Bug Report
+description: Report a new problem encountered using the theme
+labels: [bug]
+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)
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Describe the issue and how to reproduce it, including what you expected to happen.
+    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
+    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
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - 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

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 💡 Feature Request
+    url: https://github.com/jpanther/congo/discussions
+    about: Request and discuss enhancements using GitHub Discussions
+  - name: 🙋‍♀️ Question
+    url: https://github.com/jpanther/congo/discussions
+    about: Please ask and answer general questions using GitHub Discussions

.github/ISSUE_TEMPLATE/i18n-issue.yml

@@ -0,0 +1,45 @@
+name: 💬 i18n Issue
+description: Report an issue with i18n or translations
+labels: [i18n]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this issue report!
+  - type: input
+    id: language
+    attributes:
+      label: Language
+      description: Which language are you using?
+      placeholder: eg. English
+    validations:
+      required: true
+  - type: textarea
+    id: issue
+    attributes:
+      label: What's the issue?
+      description: Describe the translation issue and how to reproduce it.
+    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
+    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
+    validations:
+      required: true
+  - 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

.github/workflows/gh-pages.yml

@@ -24,7 +24,7 @@ jobs:
 
       - name: Build
         working-directory: ./exampleSite
-        run: hugo --minify --themesDir ../.. --baseURL https://jpanther.github.io/Congo/
+        run: hugo --minify --themesDir ../.. --baseURL https://jpanther.github.io/congo/
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

CHANGELOG.md

@@ -53,6 +53,6 @@ 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/v1.1.0...HEAD
-[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
+[unreleased]: https://github.com/jpanther/congo/compare/v1.1.0...HEAD
+[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

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+## How to contribute to Congo
+
+### Bugs & other issues
+
+#### Found a bug? 🐛
+
+- **Ensure the bug has not already been reported** by searching [GitHub Issues](https://github.com/jpanther/congo/issues). If there's already an open issue, feel free to add any extra information you might have about the issue.
+- If you're unable to find an open issue matching the problem, [open a new one](https://github.com/jpanther/congo/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample**, **screenshot**, or a **test case** demonstrating the expected behavior that is not occurring.
+- Where possible, use the bug report templates to create the issue. Avoid including descriptions like "bug", "feature", etc in the issue title as these will be handled by labels.
+
+#### Have a patch that fixes an issue?
+
+- Great! Open a new GitHub pull request with the patch.
+- All development occurs on the `dev` branch and new PRs should be forked from here.
+- The command `npm run example` can be used to test local changes using the example site.
+- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number, if applicable.
+- **Before submitting**, check the [coding conventions](#coding-conventions) section below to learn more about coding and commit message expectations.
+
+### New features & enhancements
+
+#### Do you intend to add a new feature, or change an existing one?
+
+- Enhancements are welcome but before implementing any features, be sure to suggest your change by opening a [new discussion](https://github.com/jpanther/congo/discussions/new) about your idea. Enhancements are discussed to ensure they fit with the project's design intent and overall roadmap.
+- Before opening a discussion, [check to see](https://github.com/jpanther/congo/discussions/categories/ideas) if a similar idea is already being discussed.
+- All ideas and suggestions are welcome and will be judged on their merits.
+- If the community supports your idea, go ahead and submit a PR with the implemented feature.
+
+### Questions? 🙋‍♀️
+
+- If you have a general question, these should be asked using [GitHub Discussions](https://github.com/jpanther/congo/discussions). Feel free to open a [new discussion](https://github.com/jpanther/congo/discussions/new) to ask your question using the "Q&A" category.
+- Be sure to check if your question has already been answered by searching [existing Q&A discussions](https://github.com/jpanther/congo/discussions/categories/q-a).
+
+### Coding conventions
+
+- 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.
+- 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`).
+- 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.
+
+The project includes a Prettier config that helps to format code in line with these guidelines.
+
+#### Commit message guidelines
+
+- Use [Gitmoji](https://gitmoji.dev) in commit messages to provide context and.
+- Clearly describe the change with a short summary in the first 72 characters.
+- Place more detailed explanations in paragraphs below the summary, separated by a blank line.
+- Use imperative language (ie. "Fix bug", not "Fixed bug" or "Fixes bug").
+- Do not end the summary line with a period.
+- Reference any issues fixed using their GitHub issue number.

README.md

@@ -1,11 +1,13 @@
 # Congo
 
-Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tailwind CSS with a clean and minimalist design.
+Congo is designed to be a simple, lightweight theme for [Hugo](https://gohugo.io). It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content.
 
-🌏 [Demo site](https://jpanther.github.io/Congo/)  
-📑 [Theme documentation](https://jpanther.github.io/Congo/docs/)
+🌏 [Demo site](https://jpanther.github.io/congo/)  
+📑 [Theme documentation](https://jpanther.github.io/congo/docs/)  
+🐛 [Bug reports & issues](https://github.com/jpanther/congo/issues)  
+💡 [Questions & feature requests](https://github.com/jpanther/congo/discussions)
 
-![Screenshot](https://raw.githubusercontent.com/jpanther/Congo/stable/images/screenshot.png)
+![Screenshot](https://raw.githubusercontent.com/jpanther/congo/stable/images/screenshot.png)
 
 ## Features
 
@@ -26,13 +28,13 @@ Congo is designed to be a fast, lightweight theme for Hugo. It's based upon Tail
 - Favicons support
 - Comments support
 - Advanced customisation using simple Tailwind colour definitions and styles
-- [Fully documented](https://jpanther.github.io/Congo/docs/)
+- [Fully documented](https://jpanther.github.io/congo/docs/)
 
 ---
 
 ## Installation
 
-This is a simplified set of instructions and assumes a basic understanding of building Hugo sites and installing themes. For detailed instructions, refer to the full [theme documentation](https://jpanther.github.io/Congo/docs/).
+This is a simplified set of instructions and assumes a basic understanding of building Hugo sites and installing themes. For detailed instructions, refer to the full [theme documentation](https://jpanther.github.io/congo/docs/).
 
 There are a couple of ways to install the Congo theme into your Hugo website. The git method is the easiest to keep the theme up-to-date, but you can also download and install manually if you don't have git available.
 
@@ -43,12 +45,12 @@ Change into the directory for your Hugo website, initialise a new repository and
 ```bash
 cd mywebsite
 git init
-git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo
+git submodule add -b stable https://github.com/jpanther/congo.git themes/congo
 ```
 
 ### Install manually
 
-Download the latest release of the theme from: [https://github.com/jpanther/Congo/releases](https://github.com/jpanther/Congo/releases)
+Download the latest release of the theme from: [https://github.com/jpanther/congo/releases](https://github.com/jpanther/congo/releases)
 
 Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your Hugo project.
 
@@ -60,7 +62,7 @@ You're now all set up to use Congo. From here you can add some content and start
 
 ## Configuration
 
-For all the theme options and detailed configuration instructions, refer to the [Congo docs](https://jpanther.github.io/Congo/docs/).
+For all the theme options and detailed configuration instructions, refer to the [Congo docs](https://jpanther.github.io/congo/docs/).
 
 A few things you need to set for a new installation:
 
@@ -139,10 +141,10 @@ Now whenever you make a change, the (non-minified) CSS files will be rebuilt aut
 
 Congo is still very much a work in progress. I intend to keep adding features and making changes as required.
 
-### Bugs & Suggestions
+Feel free to get in touch with any issues or suggestions for new features you'd like to see.
 
-Feel free to get in touch with any issues or suggestions for new features you'd like to see. Please use GitHub issues for all bug reports and suggestions to help keep everything in one spot.
+- 🐛 **Bug reports & issues:** Use [GitHub Issues](https://github.com/jpanther/congo/issues)
+- 💡 **Ideas for new features:** Open a discussion on [GitHub Discussions](https://github.com/jpanther/congo/discussions)
+- 🙋‍♀️ **General questions:** Head to [GitHub Discussions](https://github.com/jpanther/congo/discussions)
 
-If you're able to fix a bug or implement a new feature, I welcome PRs for this purpose.
-
-All development occurs on the `dev` branch and new PRs should be forked from here.
+If you're able to fix a bug or implement a new feature, I welcome PRs for this purpose. Learn more in the [contributing guidelines](https://github.com/jpanther/congo/CONTRIBUTING.md).

config/_default/config.toml

@@ -1,6 +1,6 @@
 # -- Site Configuration --
 # Refer to the theme docs for more details about each of these parameters.
-# https://jpanther.github.io/Congo/docs/getting-started/
+# https://jpanther.github.io/congo/docs/getting-started/
 
 theme = "congo"
 

config/_default/params.toml

@@ -3,7 +3,7 @@
 # customise the display of your website.
 #
 # Refer to the theme docs for more details about each of these parameters.
-# https://jpanther.github.io/Congo/docs/configuration/#theme-parameters
+# https://jpanther.github.io/congo/docs/configuration/#theme-parameters
 
 # description = "My awesome website"
 # mainSections = ["section1", "section2"]

exampleSite/config.toml

@@ -4,10 +4,10 @@
 # as it does not contain all the required theme settings!
 #
 # Refer to the theme docs for configuration instructions if you're unsure.
-# https://jpanther.github.io/Congo/docs/
+# https://jpanther.github.io/congo/docs/
 # --------------------------------------------------------------------------
 
-baseURL = "https://jpanther.github.io/Congo/"
+baseURL = "https://jpanther.github.io/congo/"
 theme = "Congo"
 languageCode = "en-AU"
 defaultContentLanguage = "en"
@@ -54,7 +54,7 @@ relativeURLs = true
 #   weight = 30
 [[menu.main]]
   name = "GitHub"
-  url = "https://github.com/jpanther/Congo"
+  url = "https://github.com/jpanther/congo"
   weight = 40
 
 [markup.goldmark]

exampleSite/content/_index.md

@@ -24,6 +24,6 @@ A simple, lightweight theme for Hugo built with Tailwind CSS.
 
 This is a demo site built entirely using Congo. It also contains a complete set of [theme documentation](/docs/). Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.
 
-Explore the [sample pages](/samples/) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/Congo) or read the [Installation guide](/docs/installation/) to get started.
+Explore the [sample pages](/samples/) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/congo) or read the [Installation guide](/docs/installation/) to get started.
 
 {{< figure src="mountains.jpg" caption="Photo by [Anna Scarfiello](https://unsplash.com/@little_anne?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText)." >}}

exampleSite/content/docs/installation.md

@@ -34,7 +34,7 @@ Change into the directory for your Hugo website, initialise a new repository and
 ```bash
 cd mywebsite
 git init
-git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo
+git submodule add -b stable https://github.com/jpanther/congo.git themes/congo
 ```
 
 {{< alert >}}
@@ -45,7 +45,7 @@ git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo
 
 Download the latest release of the theme.
 
-{{< button href="https://github.com/jpanther/Congo/releases" target="_blank" >}}Download from Github{{< /button >}}
+{{< button href="https://github.com/jpanther/congo/releases" target="_blank" >}}Download from Github{{< /button >}}
 
 Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your your `mywebsite` folder.
 

exampleSite/content/users.md

@@ -17,4 +17,4 @@ Real websites that are built with Congo.
 | Website | Details |
 | ------- | ------- |
 
-**Congo user?** To add your site to this list, [submit a pull request](https://github.com/jpanther/Congo/blob/dev/exampleSite/content/users.md).
+**Congo user?** To add your site to this list, [submit a pull request](https://github.com/jpanther/congo/blob/dev/exampleSite/content/users.md).

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hugo-congo-theme",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Congo theme for Hugo",
   "main": "index.js",
   "scripts": {
@@ -10,7 +10,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jpanther/Congo.git"
+    "url": "git+https://github.com/jpanther/congo.git"
   },
   "keywords": [
     "hugo",
@@ -21,9 +21,9 @@
   "author": "James Panther",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/jpanther/Congo/issues"
+    "url": "https://github.com/jpanther/congo/issues"
   },
-  "homepage": "https://github.com/jpanther/Congo#readme",
+  "homepage": "https://github.com/jpanther/congo#readme",
   "devDependencies": {
     "@tailwindcss/typography": "^0.4.1",
     "prettier": "^2.3.2",

theme.toml

@@ -1,14 +1,14 @@
 # Congo theme for Hugo
 
-name = "Congo"
+name = "congo"
 license = "MIT"
-licenselink = "https://github.com/jpanther/Congo/blob/master/LICENSE"
+licenselink = "https://github.com/jpanther/congo/blob/master/LICENSE"
 description = "A simple, lightweight theme for Hugo built with Tailwind CSS."
 
 min_version = "0.86.1"
 
-homepage = "https://github.com/jpanther/Congo/"
-demosite = "https://jpanther.github.io/Congo/"
+homepage = "https://github.com/jpanther/congo/"
+demosite = "https://jpanther.github.io/congo/"
 
 tags = ["blog", "minimal", "responsive", "dark mode", "dark", "light", "tailwind", "personal"]
 features = ["syntax higlighting", "dark mode", "emoji"]