diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 000000000..61a8f7129 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git,.gitignore,.gitattributes,*.svg,package-lock.json,i18n,*.css,*.min.*,.codespellrc,*/lib/*,.npm,.cache,lighthouse.html,samples,*.de.toml,*.es.toml,*.de.md,*.es.md,*.ja.toml,*.zh-Hans.toml +check-hidden = true +# ignore-regex = +# ignore-words-list = diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..2d80ec457 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,23 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [dev] + pull_request: + branches: [dev] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/.gitignore b/.gitignore index 58ad807e2..8cce13c58 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,4 @@ TODO # MacOS .DS_Store +.npm/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 97537ce97..14e5c45eb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -51,7 +51,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Fixed -- `figure` shortcode would load recursively when using the `default` paramater ([#1074](https://github.com/jpanther/congo/issues/1074)) +- `figure` shortcode would load recursively when using the `default` parameter ([#1074](https://github.com/jpanther/congo/issues/1074)) - Some partials not loading due to incorrect file paths ([#1075](https://github.com/jpanther/congo/pull/1075)) ## [2.12.0] - 2025-06-22 diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 4d6ee00f0..4a8ae3e7b 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -16,7 +16,7 @@ In addition to all the [default Hugo shortcodes](https://gohugo.io/content-manag The input is written in Markdown so you can format it however you please. -By default, the alert is presented with an exclaimation triangle icon. To change the icon, include the icon name in the shortcode. Check out the [icon shortcode](#icon) for more details on using icons. +By default, the alert is presented with an exclamation triangle icon. To change the icon, include the icon name in the shortcode. Check out the [icon shortcode](#icon) for more details on using icons. **Example:** diff --git a/exampleSite/content/docs/version-2/_index.md b/exampleSite/content/docs/version-2/_index.md index 2f4c738f3..1fce851d4 100644 --- a/exampleSite/content/docs/version-2/_index.md +++ b/exampleSite/content/docs/version-2/_index.md @@ -86,7 +86,7 @@ The new image resizing features also provide full control over `alt` and `title` ## A whole lot more -There's countless other minor changes to explore. From being able to display taxonomies on articles and list pages, to using the new `headline` author parameter to customise your homepage. There's also improved JSON-LD strucured data which further optimises SEO performance. Plus the entire theme has had extra polish to ensure a consistent design language. +There's countless other minor changes to explore. From being able to display taxonomies on articles and list pages, to using the new `headline` author parameter to customise your homepage. There's also improved JSON-LD structured data which further optimises SEO performance. Plus the entire theme has had extra polish to ensure a consistent design language. :rocket: Check out the [full changelog](https://github.com/jpanther/congo/blob/dev/CHANGELOG.md) to learn more. diff --git a/exampleSite/content/docs/version-2/upgrade/index.ja.md b/exampleSite/content/docs/version-2/upgrade/index.ja.md index 3e5760812..d146a008c 100644 --- a/exampleSite/content/docs/version-2/upgrade/index.ja.md +++ b/exampleSite/content/docs/version-2/upgrade/index.ja.md @@ -85,7 +85,7 @@ Congo 2.0では新しいテーマ設定パラメーターが多数導入され 言語設定ファイルはこのような構造になっています: ```toml -# config/_default/languagues.en.toml +# config/_default/languages.en.toml languageCode = "en" languageName = "English" diff --git a/exampleSite/content/docs/version-2/upgrade/index.md b/exampleSite/content/docs/version-2/upgrade/index.md index fb2616b11..21c04aa09 100644 --- a/exampleSite/content/docs/version-2/upgrade/index.md +++ b/exampleSite/content/docs/version-2/upgrade/index.md @@ -85,7 +85,7 @@ This step is optional if you do not need multilingual support, although completi The languages config file follows this structure: ```toml -# config/_default/languagues.en.toml +# config/_default/languages.en.toml languageCode = "en" languageName = "English" @@ -150,7 +150,7 @@ The recommended settings are as follows, which includes any headings in the Mark ### Params.toml -A number of new theme parameters have been introduced in Congo 2.0. Some minor changes are requried to existing configurations. Remember, the theme will always revert to a sensible default if a parameter is not provided. +A number of new theme parameters have been introduced in Congo 2.0. Some minor changes are required to existing configurations. Remember, the theme will always revert to a sensible default if a parameter is not provided. The way that dark mode works in Congo has been changed to allow greater flexibility around configuration. The old `darkMode` and `darkToggle` parameters have been **removed and replaced** by three new parameters. These new options operate independently of each other, making it possible to force the appearance while still allowing the user to override. @@ -159,7 +159,7 @@ The way that dark mode works in Congo has been changed to allow greater flexibil | --- | --- | --- | --- | | `defaultAppearance` | String | `"light"` | Default theme appearance; either `light` or `dark`.
:warning: _Setting this to `light` replicates the old `darkMode = false` setting, while `dark` replicates `darkMode = true`._ | | `autoSwitchAppearance` | Boolean | `true` | Whether the theme appearance automatically switches based upon the operating system preference. Set to `false` to force the site to always use the `defaultAppearance`.
:warning: _Setting this to `true` replicates the old `darkMode = "auto"` setting._ | -| `showAppearanceSwitcher` | Boolean | `false` | Whether the theme appearance switcher is dispalyed in the site footer.
:warning: _This parameter replaces `darkToggle`._ | +| `showAppearanceSwitcher` | Boolean | `false` | Whether the theme appearance switcher is displayed in the site footer.
:warning: _This parameter replaces `darkToggle`._ | The following table outlines some other key **new parameters** that control new features in version 2: diff --git a/exampleSite/content/docs/version-2/upgrade/index.zh-Hans.md b/exampleSite/content/docs/version-2/upgrade/index.zh-Hans.md index b47970c4c..3489bfcb2 100644 --- a/exampleSite/content/docs/version-2/upgrade/index.zh-Hans.md +++ b/exampleSite/content/docs/version-2/upgrade/index.zh-Hans.md @@ -85,7 +85,7 @@ Congo 2.0 引入了许多新的主题配置参数。虽然主题会适应现有 语言配置文件遵循以下结构: ```toml -# config/_default/languagues.en.toml +# config/_default/languages.en.toml languageCode = "en" languageName = "English" @@ -108,7 +108,7 @@ rtl = false 语言配置文件遵循以下结构: ```toml -# config/_default/languagues.en.toml +# config/_default/languages.en.toml languageCode = "en" languageName = "English"