diff --git a/docs/404.html b/docs/404.html index 40f536aa..1154e6df 100644 --- a/docs/404.html +++ b/docs/404.html @@ -7,7 +7,7 @@
↓Skip to main content
Blowfish -Blowfish
-

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

Figure #

Congo 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.

Congo 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 #

Congo 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.

Congo 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/version-2/index.html b/docs/docs/version-2/index.html
index eb9c6d5c..3bbad71e 100644
--- a/docs/docs/version-2/index.html
+++ b/docs/docs/version-2/index.html
@@ -7,7 +7,7 @@
 
 
 
  1. Content Samples/
Charts
·81 words·1 min·0 views
Table of Contents
Congo includes support for Chart.js using the chart shortcode. Simply wrap the chart markup within the shortcode. Congo 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 #

-