From bd460517038766ba303f00bb7856bec2823ba9e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nuno=20Cora=C3=A7=C3=A3o?= Date: Tue, 13 Sep 2022 00:55:06 +0100 Subject: [PATCH] fixed docs article --- docs/docs/index.html | 2 +- docs/docs/index.xml | 2 +- docs/docs/installation/index.html | 5 +- docs/docs/shortcodes/index.html | 4 +- docs/docs/welcome/index.html | 11 +-- docs/index.xml | 2 +- docs/samples/charts/index.html | 8 +-- docs/tags/docs/index.html | 2 +- docs/tags/new/index.html | 2 +- exampleSite/content/docs/welcome/_index.md | 79 ---------------------- 10 files changed, 22 insertions(+), 95 deletions(-) delete mode 100644 exampleSite/content/docs/welcome/_index.md diff --git a/docs/docs/index.html b/docs/docs/index.html index 3b9f4888..a528b1de 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -20,7 +20,7 @@

Documentation

Simple, yet powerful. Learn how to use Blowfish and its features.

Featured Blowfish image

This section contains everything you need to know about Blowfish. If you’re new, check out the Installation guide to begin or visit the Samples section to see what Blowfish can do.

Welcome to Blowfish 🐡

595 words·3 mins·0 views
Blowfish is packed with tons of features. The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.

Installation

976 words·5 mins·0 views
Simply follow the standard Hugo Quick Start procedure to get up and running quickly. +/blowfish/docs/featured_hud8adc593272aed8f1224d3593fe9b187_99792_1320x0_resize_box_3.png 2x" src=/blowfish/docs/featured_hud8adc593272aed8f1224d3593fe9b187_99792_660x0_resize_box_3.png alt="Featured Blowfish image">

This section contains everything you need to know about Blowfish. If you’re new, check out the Installation guide to begin or visit the Samples section to see what Blowfish can do.

Welcome to Blowfish 🐡

595 words·3 mins·0 views
Blowfish is packed with tons of features. The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.

Installation

976 words·5 mins·0 views
Simply follow the standard Hugo Quick Start procedure to get up and running quickly. Detailed installation instructions can be found below. Instructions for updating the theme are also available. Installation # These instructions will get you up and running using Hugo and Blowfish from a completely blank state.

Getting Started

897 words·5 mins·0 views
This section assumes you have already installed the Blowfish theme. The config files that ship with Blowfish contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.

Configuration

2306 words·11 mins·0 views
Blowfish is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured. The theme ships with a default configuration that gets you up and running with a basic blog or static website.

Homepage Layout

478 words·3 mins·0 views
Blowfish provides a fully flexible homepage layout. There are two main templates to choose from with additional settings to adjust the design. Alternatively, you can also provide your own template and have complete control over the homepage content.

Front Matter

542 words·3 mins·0 views
In addition to the default Hugo front matter parameters, Blowfish adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below.

Shortcodes

954 words·5 mins·0 views
In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality. diff --git a/docs/docs/index.xml b/docs/docs/index.xml index dd63daa7..808b577d 100644 --- a/docs/docs/index.xml +++ b/docs/docs/index.xml @@ -1,4 +1,4 @@ -Documentation on Blowfishhttps://nunocoracao.github.io/blowfish/docs/Recent content in Documentation on BlowfishHugo -- gohugo.ioenWed, 19 Jan 2022 00:00:00 +0000Installationhttps://nunocoracao.github.io/blowfish/docs/installation/Sun, 16 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/installation/Simply follow the standard Hugo Quick Start procedure to get up and running quickly. +Documentation on Blowfishhttps://nunocoracao.github.io/blowfish/docs/Recent content in Documentation on BlowfishHugo -- gohugo.ioenWed, 19 Jan 2022 00:00:00 +0000Welcome to Blowfish 🐡https://nunocoracao.github.io/blowfish/docs/welcome/Wed, 19 Jan 2022 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/welcome/Blowfish is packed with tons of features. The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.Installationhttps://nunocoracao.github.io/blowfish/docs/installation/Sun, 16 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/installation/Simply follow the standard Hugo Quick Start procedure to get up and running quickly. Detailed installation instructions can be found below. Instructions for updating the theme are also available. Installation # These instructions will get you up and running using Hugo and Blowfish from a completely blank state.Getting Startedhttps://nunocoracao.github.io/blowfish/docs/getting-started/Sat, 15 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/getting-started/This section assumes you have already installed the Blowfish theme. The config files that ship with Blowfish contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.Configurationhttps://nunocoracao.github.io/blowfish/docs/configuration/Fri, 14 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/configuration/Blowfish is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured. The theme ships with a default configuration that gets you up and running with a basic blog or static website.Homepage Layouthttps://nunocoracao.github.io/blowfish/docs/homepage-layout/Thu, 13 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/homepage-layout/Blowfish provides a fully flexible homepage layout. There are two main templates to choose from with additional settings to adjust the design. Alternatively, you can also provide your own template and have complete control over the homepage content.Front Matterhttps://nunocoracao.github.io/blowfish/docs/front-matter/Wed, 12 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/front-matter/In addition to the default Hugo front matter parameters, Blowfish adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below.Shortcodeshttps://nunocoracao.github.io/blowfish/docs/shortcodes/Tue, 11 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/shortcodes/In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality. diff --git a/docs/docs/installation/index.html b/docs/docs/installation/index.html index 201c38c1..ecf1d7c6 100644 --- a/docs/docs/installation/index.html +++ b/docs/docs/installation/index.html @@ -36,7 +36,10 @@ └─ params.toml
Important: If you didn’t use Hugo Modules to install Blowfish, you must add the line theme = "blowfish" to the top of your config.toml file.

Next steps #

The basic Blowfish installation is now complete. Continue to the Getting Started section to learn more about configuring the theme.

Installing updates #

From time to time there will be new releases posted that apply fixes and add new functionality to the theme. In order to take advantage of these changes, you will need to update the theme files on your website.

How you go about this will depend on the installation method you chose when the theme was originally installed. Instructions for each method can be found below.

Update using Hugo #

Hugo makes updating modules super easy. Simply change into your project directory and execute the following command:

hugo mod get -u

Hugo will automatically update any modules that are required for your project. It does this by inspecting your module.toml and go.mod files. If you have any issues with the update, check to ensure these files are still configured correctly.

Then simply rebuild your site and check everything works as expected.

Update using git #

Git submodules can be updated using the git command. Simply execute the following command and the latest version of the theme will be downloaded into your local repository:

git submodule update --remote --merge
-

Once the submodule has been updated, rebuild your site and check everything works as expected.

Update manually #

Updating Blowfish manually requires you to download the latest copy of the theme and replace the old version in your project.

Note that any local customisations you have made to the theme files will be lost during this process.

  1. Download the latest release of the theme source code.

    Download from Github

  2. Extract the archive, rename the folder to blowfish and move it to the themes/ directory inside your Hugo project’s root folder. You will need to overwrite the existing directory to replace all the theme files.

  3. Rebuild your site and check everything works as expected.

Getting Started +

Once the submodule has been updated, rebuild your site and check everything works as expected.

Update manually #

Updating Blowfish manually requires you to download the latest copy of the theme and replace the old version in your project.

Note that any local customisations you have made to the theme files will be lost during this process.

  1. Download the latest release of the theme source code.

    Download from Github

  2. Extract the archive, rename the folder to blowfish and move it to the themes/ directory inside your Hugo project’s root folder. You will need to overwrite the existing directory to replace all the theme files.

  3. Rebuild your site and check everything works as expected.

↑

© 2022 diff --git a/docs/docs/shortcodes/index.html b/docs/docs/shortcodes/index.html index 7ffe0e6d..4b1d26d6 100644 --- a/docs/docs/shortcodes/index.html +++ b/docs/docs/shortcodes/index.html @@ -45,8 +45,8 @@ }] } {{< /chart >}} -

-

You can see some additional Chart.js examples on the charts samples page.

Figure #

Blowfish includes a figure shortcode for adding images to content. The shortcode replaces the base Hugo functionality in order to provide additional performance benefits.

When a provided image is a page resource, it will be optimised using Hugo Pipes and scaled in order to provide images appropriate to different device resolutions. If a static asset or URL to an external image is provided, it will be included as-is without any image processing by Hugo.

The figure shortcode accepts six parameters:

ParameterDescription
srcRequired. The local path/filename or URL of the image. When providing a path and filename, the theme will attempt to locate the image using the following lookup order: Firstly, as a page resource bundled with the page; then an asset in the assets/ directory; then finally, a static image in the static/ directory.
altAlternative text description for the image.
captionMarkdown for the image caption, which will be displayed below the image.
classAdditional CSS classes to apply to the image.
hrefURL that the image should be linked to.
defaultSpecial parameter to revert to default Hugo figure behaviour. Simply provide default=true and then use normal Hugo shortcode syntax.

Blowfish also supports automatic conversion of images included using standard Markdown syntax. Simply use the following format and the theme will handle the rest:

![Alt text](image.jpg "Image caption")
+
+

You can see some additional Chart.js examples on the charts samples page.

Figure #

Blowfish includes a figure shortcode for adding images to content. The shortcode replaces the base Hugo functionality in order to provide additional performance benefits.

When a provided image is a page resource, it will be optimised using Hugo Pipes and scaled in order to provide images appropriate to different device resolutions. If a static asset or URL to an external image is provided, it will be included as-is without any image processing by Hugo.

The figure shortcode accepts six parameters:

ParameterDescription
srcRequired. The local path/filename or URL of the image. When providing a path and filename, the theme will attempt to locate the image using the following lookup order: Firstly, as a page resource bundled with the page; then an asset in the assets/ directory; then finally, a static image in the static/ directory.
altAlternative text description for the image.
captionMarkdown for the image caption, which will be displayed below the image.
classAdditional CSS classes to apply to the image.
hrefURL that the image should be linked to.
defaultSpecial parameter to revert to default Hugo figure behaviour. Simply provide default=true and then use normal Hugo shortcode syntax.

Blowfish also supports automatic conversion of images included using standard Markdown syntax. Simply use the following format and the theme will handle the rest:

![Alt text](image.jpg "Image caption")

Example:

{{< figure
     src="abstract.jpg"
     alt="Abstract purple artwork"
diff --git a/docs/docs/welcome/index.html b/docs/docs/welcome/index.html
index f3197dbc..dfbd43e4 100644
--- a/docs/docs/welcome/index.html
+++ b/docs/docs/welcome/index.html
@@ -1,8 +1,8 @@
-Welcome to Blowfish 🐡 · Blowfish
+Welcome to Blowfish 🐡 · Blowfish
 
 
 
-
+
 
 
 
@@ -17,7 +17,8 @@

Welcome to Blowfish 🐡

Blowfish is packed with tons of features.

The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.

Tailwind CSS 3.0 #

Tailwind CSS is at the heart of Blowfish and this release contains the very latest Tailwind CSS version 3. It brings with it performance optimisations and support for some great new CSS features.

Multilingual support #

A highly requested feature, Blowfish is now multilingual! If you publish your content in multiple languages, the site will be built with all the translations available.

🇬🇧 🇩🇪 🇫🇷 🇪🇸 🇨🇳 🇧🇷 🇹🇷 🇧🇩

Thanks to submissions from the community, Blowfish has already been translated into eight languages with more to be added over time. By the way, pull requests for new languages are always welcome!

RTL language support #

One of the benefits of the new Tailwind and Multilingual features is the ability to add RTL language support. When enabled, the entire site will reflow content from right-to-left. Every element in the theme has been restyled to ensure it looks great in this mode which aids authors who wish to generate content in RTL languages.

RTL is controlled on a per-language basis so you can mix and match both RTL and LTR content in your projects and the theme will respond accordingly.

Automatic image resizing #

A big change in Blowfish 2.0 is the addition of automatic image resizing. Using the power of Hugo Pipes, images in Markdown content are now automatically scaled to different output sizes. These are then presented using HTML srcset attributes enabling optimised file sizes to be served to your site visitors.

  1. Documentation/

Welcome to Blowfish 🐡

595 words·3 mins·0 views· +
Table of Contents
Blowfish is packed with tons of features.

The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.

Tailwind CSS 3.0 #

Tailwind CSS is at the heart of Blowfish and this release contains the very latest Tailwind CSS version 3. It brings with it performance optimisations and support for some great new CSS features.

Multilingual support #

A highly requested feature, Blowfish is now multilingual! If you publish your content in multiple languages, the site will be built with all the translations available.

🇬🇧 🇩🇪 🇫🇷 🇪🇸 🇨🇳 🇧🇷 🇹🇷 🇧🇩

Thanks to submissions from the community, Blowfish has already been translated into eight languages with more to be added over time. By the way, pull requests for new languages are always welcome!

RTL language support #

One of the benefits of the new Tailwind and Multilingual features is the ability to add RTL language support. When enabled, the entire site will reflow content from right-to-left. Every element in the theme has been restyled to ensure it looks great in this mode which aids authors who wish to generate content in RTL languages.

RTL is controlled on a per-language basis so you can mix and match both RTL and LTR content in your projects and the theme will respond accordingly.

Automatic image resizing #

A big change in Blowfish 2.0 is the addition of automatic image resizing. Using the power of Hugo Pipes, images in Markdown content are now automatically scaled to different output sizes. These are then presented using HTML srcset attributes enabling optimised file sizes to be served to your site visitors.

<!-- Markdown: ![My image](image.jpg) -->
@@ -30,7 +31,9 @@
   src="/image_635x0_resize_q75_box.jpg"
   alt="My image"
 />
-

Best of all there’s nothing you need to change! Simply insert standard Markdown image syntax and let the theme do the rest. If you want a little more control, the figure shortcode has been completely rewritten to provide the same resizing benefits.

Powered by Fuse.js, site search allows visitors to quickly and easily find your content. All searches are performed client-side meaning there’s nothing to configure on the server and queries are performed super fast. Simply enable the feature in your site configuration and you’re all set. Oh, and it also supports full keyboard navigation!

Tables of contents #

A highly requested feature, Blowfish now supports tables of contents on article pages. You can see it in action on this page. The contents are fully responsive and will adjust to take advantage of the space available at different screen resolutions.

Available on a global or per article basis, the table of contents can be fully customised using standard Hugo configuration values, allowing you to adjust the behaviour to suit your project.

Accessibility improvements #

From adding ARIA descriptions to more items or simply adjusting the contrast of certain text elements, this release is the most accessible yet.

Version 2 also introduces “skip to content” and “scroll to top” links that enable quick navigation. There’s also keyboard shortcuts for enabling items like search without reaching for the mouse.

The new image resizing features also provide full control over alt and title elements enabling an accessible experience for all visitors.

A whole lot more #

There’s countless other features 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.

There's no articles to list here yet.

↑

© +

Best of all there’s nothing you need to change! Simply insert standard Markdown image syntax and let the theme do the rest. If you want a little more control, the figure shortcode has been completely rewritten to provide the same resizing benefits.

Powered by Fuse.js, site search allows visitors to quickly and easily find your content. All searches are performed client-side meaning there’s nothing to configure on the server and queries are performed super fast. Simply enable the feature in your site configuration and you’re all set. Oh, and it also supports full keyboard navigation!

Tables of contents #

A highly requested feature, Blowfish now supports tables of contents on article pages. You can see it in action on this page. The contents are fully responsive and will adjust to take advantage of the space available at different screen resolutions.

Available on a global or per article basis, the table of contents can be fully customised using standard Hugo configuration values, allowing you to adjust the behaviour to suit your project.

Accessibility improvements #

From adding ARIA descriptions to more items or simply adjusting the contrast of certain text elements, this release is the most accessible yet.

Version 2 also introduces “skip to content” and “scroll to top” links that enable quick navigation. There’s also keyboard shortcuts for enabling items like search without reaching for the mouse.

The new image resizing features also provide full control over alt and title elements enabling an accessible experience for all visitors.

A whole lot more #

There’s countless other features 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.

↑

© 2022 Blowfish

Powered by Hugo & Blowfish

\ No newline at end of file diff --git a/docs/index.xml b/docs/index.xml index e2e56736..211d9699 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -1,4 +1,4 @@ -Welcome to Blowfish! :tada: on Blowfishhttps://nunocoracao.github.io/blowfish/Recent content in Welcome to Blowfish! :tada: on BlowfishHugo -- gohugo.ioenMon, 13 Jun 2022 20:55:37 +0100Installationhttps://nunocoracao.github.io/blowfish/docs/installation/Sun, 16 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/installation/Simply follow the standard Hugo Quick Start procedure to get up and running quickly. +Welcome to Blowfish! :tada: on Blowfishhttps://nunocoracao.github.io/blowfish/Recent content in Welcome to Blowfish! :tada: on BlowfishHugo -- gohugo.ioenMon, 13 Jun 2022 20:55:37 +0100Welcome to Blowfish 🐡https://nunocoracao.github.io/blowfish/docs/welcome/Wed, 19 Jan 2022 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/welcome/Blowfish is packed with tons of features. The original aim of Blowfish was to develop a theme that was simple and lightweight. The theme is a fork of Congo and expands its initial vision.Installationhttps://nunocoracao.github.io/blowfish/docs/installation/Sun, 16 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/installation/Simply follow the standard Hugo Quick Start procedure to get up and running quickly. Detailed installation instructions can be found below. Instructions for updating the theme are also available. Installation # These instructions will get you up and running using Hugo and Blowfish from a completely blank state.Getting Startedhttps://nunocoracao.github.io/blowfish/docs/getting-started/Sat, 15 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/getting-started/This section assumes you have already installed the Blowfish theme. The config files that ship with Blowfish contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.Configurationhttps://nunocoracao.github.io/blowfish/docs/configuration/Fri, 14 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/configuration/Blowfish is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured. The theme ships with a default configuration that gets you up and running with a basic blog or static website.Iconshttps://nunocoracao.github.io/blowfish/samples/icons/Fri, 14 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/icons/Blowfish has built-in support for a number of FontAwesome 6 icons. These can be included in your website through either the icon partial or icon shortcode. diff --git a/docs/samples/charts/index.html b/docs/samples/charts/index.html index e1d186f7..1bbf537a 100644 --- a/docs/samples/charts/index.html +++ b/docs/samples/charts/index.html @@ -18,10 +18,10 @@
  1. Content Samples/

Charts

81 words·1 min·0 views
Table of Contents

Blowfish includes support for Chart.js using the chart shortcode. Simply wrap the chart markup within the shortcode. Blowfish automatically themes charts to match the configured colorScheme parameter, however the colours can be customised using normal Chart.js syntax.

Refer to the chart shortcode docs for more details.

The examples below are a small selection taken from the official Chart.js docs. You can also view the page source on GitHub to see the markup.

Bar chart #

-

Line chart #

-

Doughnut chart #

-