diff --git a/docs/404.html b/docs/404.html index 871ea188..16252853 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,4 +1,4 @@ -404 Page not found · Blowfish +404 Page not found · Blowfish diff --git a/docs/categories/index.html b/docs/categories/index.html index d722a438..c912679e 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -1,4 +1,4 @@ -Categories · Blowfish +Categories · Blowfish diff --git a/docs/docs/advanced-customisation/index.html b/docs/docs/advanced-customisation/index.html index 80b2793b..c8fc465b 100644 --- a/docs/docs/advanced-customisation/index.html +++ b/docs/docs/advanced-customisation/index.html @@ -1,4 +1,4 @@ -Advanced Customisation · Blowfish +Advanced Customisation · Blowfish diff --git a/docs/docs/configuration/index.html b/docs/docs/configuration/index.html index c1072515..b0ca3941 100644 --- a/docs/docs/configuration/index.html +++ b/docs/docs/configuration/index.html @@ -1,4 +1,4 @@ -Configuration · Blowfish +Configuration · Blowfish diff --git a/docs/docs/content-examples/index.html b/docs/docs/content-examples/index.html index 19919b8c..c3b73f68 100644 --- a/docs/docs/content-examples/index.html +++ b/docs/docs/content-examples/index.html @@ -1,4 +1,4 @@ -Content Examples · Blowfish +Content Examples · Blowfish diff --git a/docs/docs/firebase-views/index.html b/docs/docs/firebase-views/index.html index 5f6ce698..ba4e4c36 100644 --- a/docs/docs/firebase-views/index.html +++ b/docs/docs/firebase-views/index.html @@ -1,4 +1,4 @@ -Firebase: Views & Likes · Blowfish +Firebase: Views & Likes · Blowfish diff --git a/docs/docs/front-matter/index.html b/docs/docs/front-matter/index.html index 99fbac1f..613cbda5 100644 --- a/docs/docs/front-matter/index.html +++ b/docs/docs/front-matter/index.html @@ -1,4 +1,4 @@ -Front Matter · Blowfish +Front Matter · Blowfish diff --git a/docs/docs/getting-started/index.html b/docs/docs/getting-started/index.html index 5fdc5c58..8c5b4a3e 100644 --- a/docs/docs/getting-started/index.html +++ b/docs/docs/getting-started/index.html @@ -1,4 +1,4 @@ -Getting Started · Blowfish +Getting Started · Blowfish diff --git a/docs/docs/homepage-layout/index.html b/docs/docs/homepage-layout/index.html index 58cf069c..0a0e1f86 100644 --- a/docs/docs/homepage-layout/index.html +++ b/docs/docs/homepage-layout/index.html @@ -1,4 +1,4 @@ -Homepage Layout · Blowfish +Homepage Layout · Blowfish diff --git a/docs/docs/hosting-deployment/index.html b/docs/docs/hosting-deployment/index.html index 2d55c9e4..e9f900e7 100644 --- a/docs/docs/hosting-deployment/index.html +++ b/docs/docs/hosting-deployment/index.html @@ -1,4 +1,4 @@ -Hosting & Deployment · Blowfish +Hosting & Deployment · Blowfish diff --git a/docs/docs/index.html b/docs/docs/index.html index 00cce8e5..28cd84e1 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -1,4 +1,4 @@ -Documentation · Blowfish +Documentation · Blowfish diff --git a/docs/docs/installation/index.html b/docs/docs/installation/index.html index cc2ad9fa..dd2dc76d 100644 --- a/docs/docs/installation/index.html +++ b/docs/docs/installation/index.html @@ -1,4 +1,4 @@ -Installation · Blowfish +Installation · Blowfish diff --git a/docs/docs/partials/index.html b/docs/docs/partials/index.html index 29b71bad..f024eaaa 100644 --- a/docs/docs/partials/index.html +++ b/docs/docs/partials/index.html @@ -1,4 +1,4 @@ -Partials · Blowfish +Partials · Blowfish diff --git a/docs/docs/shortcodes/index.html b/docs/docs/shortcodes/index.html index 56bb3c6e..64e89b6a 100644 --- a/docs/docs/shortcodes/index.html +++ b/docs/docs/shortcodes/index.html @@ -1,4 +1,4 @@ -Shortcodes · Blowfish +Shortcodes · Blowfish @@ -54,8 +54,8 @@ Like }] } {{< /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/thumbnails/index.html b/docs/docs/thumbnails/index.html
index 8597d9f5..0ceff11e 100644
--- a/docs/docs/thumbnails/index.html
+++ b/docs/docs/thumbnails/index.html
@@ -1,4 +1,4 @@
-Thumbnails · Blowfish
+Thumbnails · Blowfish
 
 
 
diff --git a/docs/docs/welcome/index.html b/docs/docs/welcome/index.html
index 5f4ea00f..f5083106 100644
--- a/docs/docs/welcome/index.html
+++ b/docs/docs/welcome/index.html
@@ -1,4 +1,4 @@
-Welcome to Blowfish 🐡 · Blowfish
+Welcome to Blowfish 🐡 · Blowfish
 
 
 
diff --git a/docs/index.html b/docs/index.html
index 01adf46f..08bfe703 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,4 +1,4 @@
-Blowfish
+Blowfish
 
 
 
diff --git a/docs/posts/index.html b/docs/posts/index.html
index ecca2916..8f1d88a5 100644
--- a/docs/posts/index.html
+++ b/docs/posts/index.html
@@ -1,4 +1,4 @@
-Posts · Blowfish
+Posts · Blowfish
 
 
 
diff --git a/docs/samples/charts/index.html b/docs/samples/charts/index.html
index 4b147197..e792279e 100644
--- a/docs/samples/charts/index.html
+++ b/docs/samples/charts/index.html
@@ -1,4 +1,4 @@
-Charts · Blowfish
+Charts · Blowfish
 
 
 
@@ -25,10 +25,10 @@
 Like
chart sample graph -shortcodes
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 #

-