diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d91ed1fe..804668a2 100644 --- a/CONTRIBUTING.md +++ b/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 `{{}}`). - 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. diff --git a/README.md b/README.md index 648efd92..8e472a9d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Blowfish is designed to be a powerful, lightweight theme for [Hugo](https://gohu - Flexible with any content types, taxonomies and menus - Header and footer menus - Nested menus & sub-navigation menu -- 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 - Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels - Buymeacoffee integration diff --git a/config.toml b/config.toml index 7160e606..89b017be 100644 --- a/config.toml +++ b/config.toml @@ -1,5 +1,5 @@ [module] - [module.hugoVersion] - extended = true - min = "0.87.0" - max = "0.121.2" \ No newline at end of file +[module.hugoVersion] +extended = true +min = "0.87.0" +max = "0.121.2" \ No newline at end of file diff --git a/exampleSite/content/docs/advanced-customisation/index.md b/exampleSite/content/docs/advanced-customisation/index.md index 6d03c21a..cfa95e89 100644 --- a/exampleSite/content/docs/advanced-customisation/index.md +++ b/exampleSite/content/docs/advanced-customisation/index.md @@ -56,7 +56,7 @@ Blowfish ships with a number of colour schemes out of the box. To change the bas In addition to the default schemes, you can also create your own and re-style the entire website to your liking. Schemes are created by by placing a `.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration. {{< alert "github">}} -**Note:** generating these files manually can be hard, I've built a `nodejs` terminal tool to help with that, [Fugu](https://github.com/nunocoracao/fugu). In a nutshell, you pass the main three `hex` values of your colour palette and the program will output a css file that can be imported directly into Blowfish. +**Note:** generating these files manually can be hard, I've built a `nodejs` terminal tool to help with that, [Fugu](https://github.com/nunocoracao/fugu). In a nutshell, you pass the main three `hex` values of your color palette and the program will output a css file that can be imported directly into Blowfish. {{< /alert >}} diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md index 6a425329..75fd9ed1 100644 --- a/exampleSite/content/docs/configuration/index.md +++ b/exampleSite/content/docs/configuration/index.md @@ -169,7 +169,7 @@ Many of the article defaults here can be overridden on a per article basis by sp | `disableImageOptimization` | `false` | Disables image resize and optimization features across all the images in the site. | | `disableTextInHeader` | `false` | Disables text in header, useful for logo based headers. | | `defaultBackgroundImage` | _Not set_ | Default background image for both `background` homepage layout and `background` hero style | -| `defaultFeaturedImage` | _Not set_ | Default background image for all `featured` images across articles, will be overridden by a local `featured` image. | +| `defaultFeaturedImage` | _Not set_ | Default background image for all `featured` images across articles, will be overridden by a local `featured` image. | | `highlightCurrentMenuArea` | _Not set_ | Marks menu entries in the main menu when selected | | `smartTOC` | _Not set_ | Activate smart Table of Contents, items in view will be highlighted. | | `smartTOCHideUnfocusedChildren` | _Not set_ | When smart Table of Contents is turned on, this will hide deeper levels of the table when they are not in focus. | diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index 868ca079..978fd688 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -316,12 +316,12 @@ In order to add images to the gallery, use `img` tags for each image and add `cl `gitlab` allows you to quickly link a GitLab Project (GitLab's jargon for repo). It displays realtime stats about it, such as the number of stars and forks it has. Unlike `github` it can't display the main programming language of a project. -Finally custom GitLab instance URL can be provided, as long as the `api/v4/projects/` endpoint is available, making this shortcode compatible with most self-hosted / enterprise deployments. +Finally, custom GitLab instance URL can be provided, as long as the `api/v4/projects/` endpoint is available, making this shortcode compatible with most self-hosted / enterprise deployments. -| Parameter | Description | -| ----------- | ----------------------------------------------------------------------- | -| `projectID` | [String] gitlab numeric ProjectID | +| Parameter | Description | +| ----------- | ---------------------------------------------------------------------- | +| `projectID` | [String] gitlab numeric ProjectID | | `baseURL` | [String] optional gitlab instance URL, default is `https://gitlab.com/` | @@ -576,7 +576,7 @@ The `timeline` creates a visual timeline that can be used in different use-cases | ----------- | -------------------------------------------- | | `icon` | the icon to be used in the timeline visuals. | | `header` | header for each entry | -| `badge` | text to place within the top right badge | +| `badge` | text to place within the top right badge | | `subheader` | entry's subheader | diff --git a/package.json b/package.json index 55611954..f7da7e3c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hugo-blowfish-theme", - "version": "2.49.1", + "version": "2.50.0", "description": "Blowfish theme for Hugo", "scripts": { "postinstall": "vendor-copy",