Merge branch 'dev' into fix-typos

This commit is contained in:
Nuno Coração 2024-01-07 22:32:19 +00:00 committed by GitHub
commit 768352a7a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 15 additions and 15 deletions

View file

@ -35,9 +35,9 @@
- Indent using 2 spaces (soft tabs). - 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>}}`). - 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. - 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. - 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. - 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. - Commit often, preferring incremental changes rather than bundling everything into a single, large commit.

View file

@ -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 - Flexible with any content types, taxonomies and menus
- Header and footer menus - Header and footer menus
- Nested menus & sub-navigation menu - 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 - Ability to link to posts on third-party websites
- Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels - Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels
- Buymeacoffee integration - Buymeacoffee integration

View file

@ -1,5 +1,5 @@
[module] [module]
[module.hugoVersion] [module.hugoVersion]
extended = true extended = true
min = "0.87.0" min = "0.87.0"
max = "0.121.2" max = "0.121.2"

View file

@ -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 `<scheme-name>.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration. 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 `<scheme-name>.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">}} {{< 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 >}} {{< /alert >}}

View file

@ -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. | | `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. | | `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 | | `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 | | `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. | | `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. | | `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. |

View file

@ -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). `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. 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. 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.
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
| Parameter | Description | | Parameter | Description |
| ----------- | ----------------------------------------------------------------------- | | ----------- | ---------------------------------------------------------------------- |
| `projectID` | [String] gitlab numeric ProjectID | | `projectID` | [String] gitlab numeric ProjectID |
| `baseURL` | [String] optional gitlab instance URL, default is `https://gitlab.com/` | | `baseURL` | [String] optional gitlab instance URL, default is `https://gitlab.com/` |
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
@ -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. | | `icon` | the icon to be used in the timeline visuals. |
| `header` | header for each entry | | `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 | | `subheader` | entry's subheader |
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->

View file

@ -1,6 +1,6 @@
{ {
"name": "hugo-blowfish-theme", "name": "hugo-blowfish-theme",
"version": "2.49.1", "version": "2.50.0",
"description": "Blowfish theme for Hugo", "description": "Blowfish theme for Hugo",
"scripts": { "scripts": {
"postinstall": "vendor-copy", "postinstall": "vendor-copy",