diff --git a/docs/docs/shortcodes/index.html b/docs/docs/shortcodes/index.html index 64e89b6a..8320b4a1 100644 --- a/docs/docs/shortcodes/index.html +++ b/docs/docs/shortcodes/index.html @@ -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/index.html b/docs/index.html
index 08bfe703..b77972c4 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -17,12 +17,39 @@
Blowfish

Blowfish

A powerful, lightweight theme for Hugo built with Tailwind CSS.

This is a demo site built entirely using Blowfish. It also contains a complete set of theme documentation. Blowfish is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.

This is a demo of the profile layout. +
Blowfish

Blowfish

A powerful, lightweight theme for Hugo built with Tailwind CSS.

This is a demo site built entirely using Blowfish. It also contains a complete set of theme documentation. Blowfish is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.

This is a demo of the profile layout.

Explore the sample pages to get a feel for what Blowfish can do. If you like what you see, check out the project on Github or read the Installation guide to get started.

Recent

Thumbnails

1 min·0 views· +0 likes
thumbnail +sample
A quick example of how to start using Thumbnails in your artciles.

Welcome to Blowfish 🐡

3 mins·0 views· +0 likes
new +docs
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

5 mins·0 views· +0 likes
installation +docs
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

5 mins·0 views· +0 likes
installation +docs
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

12 mins·0 views· +0 likes
config +docs
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.
\ No newline at end of file diff --git a/docs/samples/charts/index.html b/docs/samples/charts/index.html index e792279e..8fcad8bb 100644 --- a/docs/samples/charts/index.html +++ b/docs/samples/charts/index.html @@ -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 #

-