fixed docs article

2026-01-30 15:31:52 +00:00 · 2022-09-13 00:55:06 +01:00
parent 002db90080
commit bd46051703
10 changed files with 22 additions and 95 deletions
@@ -20,7 +20,7 @@
 <span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="search" class="svg-inline--fa fa-search fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M505 442.7 405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9.0 208 0S0 93.1.0 208s93.1 208 208 208c48.3.0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9.0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7.0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7.0 128 57.2 128 128 0 70.7-57.2 128-128 128z"/></svg></span></button></li></ul></div><div class="relative flex flex-col grow"><main id=main-content class=grow><header><h1 class="mt-0 text-4xl font-extrabold text-neutral-900 dark:text-neutral">Documentation</h1></header><section class="mt-0 prose flex max-w-full flex-col dark:prose-invert lg:flex-row"><div class="min-w-0 min-h-0 max-w-prose"><div class="lead !mb-9 text-xl">Simple, yet powerful. Learn how to use Blowfish and its features.</div><p><figure><img class="my-0 rounded-md" srcset="/blowfish/docs/featured_hud8adc593272aed8f1224d3593fe9b187_99792_330x0_resize_box_3.png 330w,
 /blowfish/docs/featured_hud8adc593272aed8f1224d3593fe9b187_99792_660x0_resize_box_3.png 660w,
 /blowfish/docs/featured_hud8adc593272aed8f1224d3593fe9b187_99792_1024x0_resize_box_3.png 1024w,
-/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"></figure></p><p>This section contains everything you need to know about Blowfish. If you&rsquo;re new, check out the <a href=https://nunocoracao.github.io/blowfish/docs/installation/>Installation</a> guide to begin or visit the <a href=https://nunocoracao.github.io/blowfish/samples/>Samples</a> section to see what Blowfish can do.</p><hr></div></section><section class=space-y-10><a class="sm:flex mb-10 article" href=/blowfish/docs/welcome/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/welcome/>Welcome to Blowfish 🐡</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>595 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">3 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/welcome/_index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/installation/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/installation/>Installation</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>976 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">5 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/installation/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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"></figure></p><p>This section contains everything you need to know about Blowfish. If you&rsquo;re new, check out the <a href=https://nunocoracao.github.io/blowfish/docs/installation/>Installation</a> guide to begin or visit the <a href=https://nunocoracao.github.io/blowfish/samples/>Samples</a> section to see what Blowfish can do.</p><hr></div></section><section class=space-y-10><a class="sm:flex mb-10 article" href=/blowfish/docs/welcome/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/welcome/>Welcome to Blowfish 🐡</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>595 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">3 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/welcome/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/installation/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/installation/>Installation</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>976 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">5 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/installation/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/getting-started/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/getting-started/>Getting Started</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>897 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">5 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/getting-started/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/configuration/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/configuration/>Configuration</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>2306 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">11 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/configuration/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/homepage-layout/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/homepage-layout/>Homepage Layout</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>478 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">3 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/homepage-layout/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/front-matter/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/front-matter/>Front Matter</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>542 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">3 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/front-matter/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">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.</div></div></a><a class="sm:flex mb-10 article" href=/blowfish/docs/shortcodes/><div class="mb-[5rem] md:mb-0"><h3 class="flex items-center text-xl font-semibold"><p class="text-neutral-800 decoration-primary-500 hover:underline hover:underline-offset-2 dark:text-neutral" href=/blowfish/docs/shortcodes/>Shortcodes</p></h3><div class="text-sm text-neutral-500 dark:text-neutral-400"><div class="flex flex-row flex-wrap items-center"><span>954 words</span><span class="px-2 text-primary-500">&#183;</span><span title="Reading time">5 mins</span><span class="px-2 text-primary-500">&#183;</span><span id=views_docs/shortcodes/index.md title=views>0 views</span></div></div><div class="py-1 prose dark:prose-invert">In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality.
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Documentation on Blowfish</title><link>https://nunocoracao.github.io/blowfish/docs/</link><description>Recent content in Documentation on Blowfish</description><generator>Hugo -- gohugo.io</generator><language>en</language><lastBuildDate>Wed, 19 Jan 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://nunocoracao.github.io/blowfish/docs/index.xml" rel="self" type="application/rss+xml"/><item><title>Installation</title><link>https://nunocoracao.github.io/blowfish/docs/installation/</link><pubDate>Sun, 16 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/installation/</guid><description>Simply follow the standard Hugo Quick Start procedure to get up and running quickly.
+<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Documentation on Blowfish</title><link>https://nunocoracao.github.io/blowfish/docs/</link><description>Recent content in Documentation on Blowfish</description><generator>Hugo -- gohugo.io</generator><language>en</language><lastBuildDate>Wed, 19 Jan 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://nunocoracao.github.io/blowfish/docs/index.xml" rel="self" type="application/rss+xml"/><item><title>Welcome to Blowfish 🐡</title><link>https://nunocoracao.github.io/blowfish/docs/welcome/</link><pubDate>Wed, 19 Jan 2022 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/welcome/</guid><description>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.</description></item><item><title>Installation</title><link>https://nunocoracao.github.io/blowfish/docs/installation/</link><pubDate>Sun, 16 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/installation/</guid><description>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.</description></item><item><title>Getting Started</title><link>https://nunocoracao.github.io/blowfish/docs/getting-started/</link><pubDate>Sat, 15 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/getting-started/</guid><description>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.</description></item><item><title>Configuration</title><link>https://nunocoracao.github.io/blowfish/docs/configuration/</link><pubDate>Fri, 14 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/configuration/</guid><description>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.</description></item><item><title>Homepage Layout</title><link>https://nunocoracao.github.io/blowfish/docs/homepage-layout/</link><pubDate>Thu, 13 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/homepage-layout/</guid><description>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.</description></item><item><title>Front Matter</title><link>https://nunocoracao.github.io/blowfish/docs/front-matter/</link><pubDate>Wed, 12 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/front-matter/</guid><description>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.</description></item><item><title>Shortcodes</title><link>https://nunocoracao.github.io/blowfish/docs/shortcodes/</link><pubDate>Tue, 11 Aug 2020 00:00:00 +0000</pubDate><guid>https://nunocoracao.github.io/blowfish/docs/shortcodes/</guid><description>In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality.
@@ -45,8 +45,8 @@
 </span></span><span class=line><span class=cl>  <span class=p>}]</span>
 </span></span><span class=line><span class=cl><span class=p>}</span>
 </span></span><span class=line><span class=cl><span class=p>{{</span><span class=o>&lt;</span> <span class=err>/chart &gt;}}</span>
-</span></span></code></pre></div><div class=chart><canvas id=175962384></canvas>
-<script type=text/javascript>window.addEventListener("DOMContentLoaded",t=>{const e=document.getElementById("175962384"),n=new Chart(e,{type:'bar',data:{labels:['Tomato','Blueberry','Banana','Lime','Orange'],datasets:[{label:'# of votes',data:[12,19,3,5,3]}]}})})</script></div><p>You can see some additional Chart.js examples on the <a href=https://nunocoracao.github.io/blowfish/samples/charts/>charts samples</a> page.</p><h2 id=figure class="relative group">Figure <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#figure aria-label=Anchor>#</a></span></h2><p>Blowfish includes a <code>figure</code> shortcode for adding images to content. The shortcode replaces the base Hugo functionality in order to provide additional performance benefits.</p><p>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.</p><p>The <code>figure</code> shortcode accepts six parameters:</p><table><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>src</code></td><td><strong>Required.</strong> 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 <a href=https://gohugo.io/content-management/page-resources/>page resource</a> bundled with the page; then an asset in the <code>assets/</code> directory; then finally, a static image in the <code>static/</code> directory.</td></tr><tr><td><code>alt</code></td><td><a href=https://moz.com/learn/seo/alt-text>Alternative text description</a> for the image.</td></tr><tr><td><code>caption</code></td><td>Markdown for the image caption, which will be displayed below the image.</td></tr><tr><td><code>class</code></td><td>Additional CSS classes to apply to the image.</td></tr><tr><td><code>href</code></td><td>URL that the image should be linked to.</td></tr><tr><td><code>default</code></td><td>Special parameter to revert to default Hugo <code>figure</code> behaviour. Simply provide <code>default=true</code> and then use normal <a href=https://gohugo.io/content-management/shortcodes/#figure>Hugo shortcode syntax</a>.</td></tr></tbody></table><p>Blowfish also supports automatic conversion of images included using standard Markdown syntax. Simply use the following format and the theme will handle the rest:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-md data-lang=md><span class=line><span class=cl>![<span class=nt>Alt text</span>](<span class=na>image.jpg &#34;Image caption&#34;</span>)
+</span></span></code></pre></div><div class=chart><canvas id=613847295></canvas>
+<script type=text/javascript>window.addEventListener("DOMContentLoaded",t=>{const e=document.getElementById("613847295"),n=new Chart(e,{type:'bar',data:{labels:['Tomato','Blueberry','Banana','Lime','Orange'],datasets:[{label:'# of votes',data:[12,19,3,5,3]}]}})})</script></div><p>You can see some additional Chart.js examples on the <a href=https://nunocoracao.github.io/blowfish/samples/charts/>charts samples</a> page.</p><h2 id=figure class="relative group">Figure <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#figure aria-label=Anchor>#</a></span></h2><p>Blowfish includes a <code>figure</code> shortcode for adding images to content. The shortcode replaces the base Hugo functionality in order to provide additional performance benefits.</p><p>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.</p><p>The <code>figure</code> shortcode accepts six parameters:</p><table><thead><tr><th>Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>src</code></td><td><strong>Required.</strong> 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 <a href=https://gohugo.io/content-management/page-resources/>page resource</a> bundled with the page; then an asset in the <code>assets/</code> directory; then finally, a static image in the <code>static/</code> directory.</td></tr><tr><td><code>alt</code></td><td><a href=https://moz.com/learn/seo/alt-text>Alternative text description</a> for the image.</td></tr><tr><td><code>caption</code></td><td>Markdown for the image caption, which will be displayed below the image.</td></tr><tr><td><code>class</code></td><td>Additional CSS classes to apply to the image.</td></tr><tr><td><code>href</code></td><td>URL that the image should be linked to.</td></tr><tr><td><code>default</code></td><td>Special parameter to revert to default Hugo <code>figure</code> behaviour. Simply provide <code>default=true</code> and then use normal <a href=https://gohugo.io/content-management/shortcodes/#figure>Hugo shortcode syntax</a>.</td></tr></tbody></table><p>Blowfish also supports automatic conversion of images included using standard Markdown syntax. Simply use the following format and the theme will handle the rest:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-md data-lang=md><span class=line><span class=cl>![<span class=nt>Alt text</span>](<span class=na>image.jpg &#34;Image caption&#34;</span>)
 </span></span></code></pre></div><p><strong>Example:</strong></p><div class=highlight><pre tabindex=0 class=chroma><code class=language-md data-lang=md><span class=line><span class=cl>{{<span class=p>&lt;</span> <span class=nt>figure</span>
 </span></span><span class=line><span class=cl>    <span class=na>src</span><span class=o>=</span><span class=s>&#34;abstract.jpg&#34;</span>
 </span></span><span class=line><span class=cl>    <span class=na>alt</span><span class=o>=</span><span class=s>&#34;Abstract purple artwork&#34;</span>