diff --git a/docs/docs/configuration/index.html b/docs/docs/configuration/index.html index c9dbf7c2..f52538a6 100644 --- a/docs/docs/configuration/index.html +++ b/docs/docs/configuration/index.html @@ -2,7 +2,7 @@ - + @@ -17,8 +17,8 @@
  1. Documentation/

Configuration

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

Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish.

The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.

As outlined in the installation instructions, you should adjust your theme configuration by modifying the files in the config/_default/ folder of your Hugo project and delete the config.toml file in your project root.

Site configuration #

Standard Hugo configuration variables are respected throughout the theme, however there are some specific things that should be configured for the best experience.

The site configuration is managed through the config/_default/config.toml file. The table below outlines all the settings that the Blowfish takes advantage of.

Note that the variable names provided in this table use dot notation to simplify the TOML data structure (ie. outputs.home refers to [outputs] home).

NameDefaultDescription
theme"blowfish"When using Hugo Modules this config value should be removed. For all other installation types, this must be set to blowfish for the theme to function.
baseURLNot setThe URL to the root of the website.
defaultContentLanguage"en"This value determines the default language of theme components and content. Refer to the language and i18n section below for supported language codes.
enableRobotsTXTtrueWhen enabled, a robots.txt file will be created in the site root that allows search engines to crawl the entire site. If you prefer to provide your own pre-made robots.txt, set to false and place your file in the static directory. For complete control, you may provide a custom layout to generate this file.
paginate10The number of articles listed on each page of the article listing.
summaryLength0The number of words that are used to generate the article summary when one is not provided in the front matter. A value of 0 will use the first sentence. This value has no effect when summaries are hidden.
outputs.home["HTML", "RSS", "JSON"]The output formats that are generated for the site. Blowfish requires HTML, RSS and JSON for all theme components to work correctly.
permalinksNot setRefer to the Hugo docs for permalink configuration.
taxonomiesNot setRefer to the Organising content section for taxonomy configuration.

Language and i18n #

Blowfish is optimised for full multilingual websites and theme assets are translated into several languages out of the box. The language configuration allows you to generate multiple versions of your content to provide a customised experience to your visitors in their native language.

The theme currently supports the following languages by default:

LanguageCode
🇬🇧 Englishen
🇧🇩 Bengalibn
🇨🇳 Simplified Chinese (China)zh-cn
🇹🇼 Traditional Chinese (Taiwan)zh-tw
🇫🇮 Finnishfi
🇫🇷 Frenchfr
🇩🇪 Germande
🇮🇱 Hebrewhe
🇭🇺 Hungarianhu
🇮🇹 Italianit
🇯🇵 Japaneseja
🇧🇷 Portuguese (Brazil)pt-br
🇵🇹 Portuguese (Portugal)pt-pt
🇷🇴 Romanianro
🇪🇸 Spanish (Spain)es
🇹🇷 Turkishtr

The default translations can be overridden by creating a custom file in i18n/[code].yaml that contains the translation strings. You can also use this method to add new languages. If you’d like to share a new translation with the community, please open a pull request.

Configuration #

In order to be as flexible as possible, a language configuration file needs to be created for each language on the website. By default Blowfish includes an English language configuration at config/_default/languages.en.toml.

The default file can be used as a template to create additional languages, or renamed if you wish to author your website in a language other than English. Simply name the file using the format languages.[language-code].toml.

Note: Ensure the defaultContentLanguage parameter in the site configuration matches the language code in your language config filename.
NameDefaultDescription
languageCode"en"The Hugo language code for this file. It can be a top-level language (ie. en) or a sub-variant (ie. en-au) and should match the language code in the filename. Hugo expects this value to always be in lowercase. For proper HTML compliance, set the isoCode parameter which is case-sensitive.
languageName"English"The name of the language.
displayName"EN"The name used when the language appears on the website.
isoCode"en"The ISO language code for HTML metadata purposes. It can be a top-level language (ie. en) or a sub-variant (ie. en-AU).
weight1The weight determines the order of languages when building multilingual sites.
rtlfalseWhether or not this is a RTL language. Set to true to reflow content from right-to-left. Blowfish fully supports using RTL and LTR languages at the same time and will dynamically adjust to both.
dateFormat"2 January 2006"How dates are formatted in this language. Refer to the Hugo docs for acceptable formats.
title"Blowfish"The title of the website. This will be displayed in the site header and footer.
descriptionNot setThe website description. This will be used in the site metadata.
copyrightNot setA Markdown string containing the copyright message to be displayed in the site footer. If none is provided, Blowfish will automatically generate a copyright string using the site title.
author.nameNot setThe author’s name. This will be displayed in article footers, and on the homepage when the profile layout is used.
author.imageNot setPath to the image file of the author. The image should be a 1:1 aspect ratio and placed in the site’s assets/ folder.
author.headlineNot setA Markdown string containing the author’s headline. It will be displayed on the profile homepage under the author’s name.
author.bioNot setA Markdown string containing the author’s bio. It will be displayed in article footers.
author.linksNot setThe links to display alongside the author’s details. The config file contains example links which can simply be uncommented to enable. The order that the links are displayed is determined by the order they appear in the array. Custom links can be added by providing corresponding SVG icon assets in assets/icons/.

Blowfish also supports language-specific menu configurations. Menu config files follow the same naming format as the languages file. Simply provide the language code in the file name to tell Hugo which language the file relates to.

Menu config files are named with the format menus.[language-code].toml. Always ensure that the language code used in the menus configuration matches the languages configuration.

The Getting Started section explains more about the structure of this file. You can also refer to the Hugo menu docs for more configuration examples.

Theme parameters #

Blowfish provides a large number of configuration parameters that control how the theme functions. The table below outlines every available parameter in the config/_default/params.toml file.

Many of the article defaults here can be overridden on a per article basis by specifying it in the front matter. Refer to the Front Matter section for further details.

NameDefaultDescription
colorScheme"blowfish"The theme colour scheme to use. Valid values are blowfish (default), avocado, ocean, fire and slate. Refer to the Colour Schemes section for more details.
defaultAppearance"light"The default theme appearance, either light or dark.
autoSwitchAppearancetrueWhether the theme appearance automatically switches based upon the visitor’s operating system preference. Set to false to force the site to always use the defaultAppearance.
enableSearchfalseWhether site search is enabled. Set to true to enable search functionality. Note that the search feature depends on the outputs.home setting in the site configuration being set correctly.
enableCodeCopyfalseWhether copy-to-clipboard buttons are enabled for <code> blocks. The highlight.noClasses parameter must be set to false for code copy to function correctly. Read more about other configuration files below.
logoNot setThe relative path to the site logo file within the assets/ folder. The logo file should be provided at 2x resolution and supports any image dimensions.
mainSectionsNot setThe sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.
robotsNot setString that indicates how robots should handle your site. If set, it will be output in the page head. Refer to Google’s docs for valid values.
header.layout"basic"The layout of the page header and menu. Valid values are basic, hamburger or custom. When set to custom, you must provide your own layout by creating a /layouts/partials/header/custom.html file.
footer.showCopyrighttrueWhether or not to show the copyright string in the site footer. Note that the string itself can be customised using the copyright parameter in the languages configuration.
footer.showThemeAttributiontrueWhether or not to show the “powered by” theme attribution in the site footer. If you choose to disable this message, please consider attributing the theme somewhere else on your site (for example, on your about page).
footer.showAppearanceSwitcherfalseWhether or not to show the appearance switcher in the site footer. The browser’s local storage is used to persist the visitor’s preference.
footer.showScrollToToptrueWhen set to true the scroll to top arrow is displayed.
homepage.layout"page"The layout of the homepage. Valid values are page, profile or custom. When set to custom, you must provide your own layout by creating a /layouts/partials/home/custom.html file. Refer to the Homepage Layout section for more details.
homepage.showRecentfalseWhether or not to display the recent articles list on the homepage.
homepage.showRecentItems5How many articles to display if showRecent is true. If variable is set to 0 or if it isn’t defined the system will default to 5 articles.
article.showDatetrueWhether or not article dates are displayed.
article.showViewsfalseWhether or not article views are displayed. This requires firebase integrations to be enabled, look below.
article.showDateUpdatedfalseWhether or not the dates articles were updated are displayed.
article.showAuthortrueWhether or not the author box is displayed in the article footer.
article.showBreadcrumbsfalseWhether or not breadcrumbs are displayed in the article header.
article.showDraftLabeltrueWhether or not the draft indicator is shown next to articles when site is built with --buildDrafts.
article.showEditfalseWhether or not the link to edit the article content should be displayed.
article.editURLNot setWhen article.showEdit is active, the URL for the edit link.
article.editAppendPathtrueWhen article.showEdit is active, whether or not the path to the current article should be appended to the URL set at article.editURL.
article.showHeadingAnchorstrueWhether or not heading anchor links are displayed alongside headings within articles.
article.showPaginationtrueWhether or not the next/previous article links are displayed in the article footer.
article.invertPaginationfalseWhether or not to flip the direction of the next/previous article links.
article.showReadingTimetrueWhether or not article reading times are displayed.
article.showTableOfContentsfalseWhether or not the table of contents is displayed on articles.
article.showTaxonomiesfalseWhether or not the taxonomies related to this article are displayed.
article.showWordCountfalseWhether or not article word counts are displayed.
article.showCommentsfalseWhether or not the comments partial is included after the article footer.
article.sharingLinksNot setWhich sharing links to display at the end of each article. When not provided, or set to false no links will be displayed.
list.showBreadcrumbsfalseWhether or not breadcrumbs are displayed in the header on list pages.
list.showTableOfContentsfalseWhether or not the table of contents is displayed on list pages.
list.showSummaryfalseWhether or not article summaries are displayed on list pages. If a summary is not provided in the front matter, one will be auto generated using the summaryLength parameter in the site configuration.
list.groupByYeartrueWhether or not articles are grouped by year on list pages.
sitemap.excludedKinds["taxonomy", "term"]Kinds of content that should be excluded from the generated /sitemap.xml file. Refer to the Hugo docs for acceptable values.
taxonomy.showTermCounttrueWhether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.
firebase.apiKeyNot setFirebase apiKey, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.authDomainNot setFirebase authDomain, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.projectIdNot setFirebase projectId, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.storageBucketNot setFirebase storageBucket, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.messagingSenderIdNot setFirebase messagingSenderId, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.appIdNot setFirebase appId, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
firebase.measurementIdNot setFirebase measurementId, required to integrate against Firebase. Check this page for a guide on how to integrate Firebase into Blowfish
fathomAnalytics.siteNot setThe site code generated by Fathom Analytics for the website. Refer to the Analytics docs for more details.
fathomAnalytics.domainNot setIf using a custom domain with Fathom Analytics, provide it here to serve script.js from the custom domain.
verification.googleNot setThe site verification string provided by Google to be included in the site metadata.
verification.bingNot setThe site verification string provided by Bing to be included in the site metadata.
verification.pinterestNot setThe site verification string provided by Pinterest to be included in the site metadata.
verification.yandexNot setThe site verification string provided by Yandex to be included in the site metadata.

Other configuration files #

The theme also includes a markup.toml configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Blowfish.

Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to fucntion incorrectly and could result in unintended behaviour.

  1. Content Samples/

Charts

81 words·1 min·0 views

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 #

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

  1. Content Samples/

Charts

81 words·1 min·0 views

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 #

+
\ No newline at end of file diff --git a/docs/samples/index.html b/docs/samples/index.html index 744f2e11..09922b20 100644 --- a/docs/samples/index.html +++ b/docs/samples/index.html @@ -17,7 +17,7 @@

Content Samples

Blowfish brings your content to life. 😍

This section contains some demo pages that show how Blowfish renders different types of content. You can also see an example taxonomy listing page.

Sidenote: This page is just a standard Blowfish article listing and Hugo has been configured to generate a samples content type and display article summaries.


Icons

·144 words·1 min·0 views
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. +

Content Samples

Blowfish brings your content to life. 😍

This section contains some demo pages that show how Blowfish renders different types of content. You can also see an example taxonomy listing page.

Sidenote: This page is just a standard Blowfish article listing and Hugo has been configured to generate a samples content type and display article summaries.


Thumbnails

·160 words·1 min·0 views
A quick example of how to start using Thumbnails in your artciles.

Icons

·144 words·1 min·0 views
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. Additionally, custom icons are also fully supported.

Markdown

·472 words·3 mins·0 views

This article offers a sample of basic Markdown formatting that can be used in Blowfish, also it shows how some basic HTML elements are decorated.

Rich Content

·145 words·1 min·0 views
This is an example of a rich content summary.

Mathematical notation

·145 words·1 min·0 views

KaTeX can be used to render mathematical notation within articles.

Diagrams and Flowcharts

·250 words·2 mins·0 views
It’s easy to add diagrams and flowcharts to articles using Mermaid.

Charts

81 words·1 min·0 views
Blowfish includes Chart.js for powerful charts and data visualisations.

Emoji 🪂

·97 words·1 min·0 views
📖🏞️🧗🏽🐉🧙🏽‍♂️🧚🏽👸

An External Article

·40 words·0 views
The externalUrl front matter parameter can link to any URL.

© diff --git a/docs/samples/index.xml b/docs/samples/index.xml index 8719ffd2..814b5347 100644 --- a/docs/samples/index.xml +++ b/docs/samples/index.xml @@ -1,2 +1,2 @@ -Content Samples on Blowfishhttps://nunocoracao.github.io/blowfish/samples/Recent content in Content Samples on BlowfishHugo -- gohugo.ioenFri, 14 Aug 2020 00:00:00 +0000Iconshttps://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. +Content Samples on Blowfishhttps://nunocoracao.github.io/blowfish/samples/Recent content in Content Samples on BlowfishHugo -- gohugo.ioenMon, 26 Sep 2022 00:00:00 +0000Thumbnailshttps://nunocoracao.github.io/blowfish/samples/thumbnail_sample/Mon, 26 Sep 2022 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/thumbnail_sample/A quick example of how to start using Thumbnails in your artciles.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. Additionally, custom icons are also fully supported.Markdownhttps://nunocoracao.github.io/blowfish/samples/markdown/Mon, 11 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/markdown/<p>This article offers a sample of basic Markdown formatting that can be used in Blowfish, also it shows how some basic HTML elements are decorated.</p>Rich Contenthttps://nunocoracao.github.io/blowfish/samples/rich-content/Sun, 10 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/rich-content/This is an <em>example</em> of a <strong>rich</strong> content summary.Mathematical notationhttps://nunocoracao.github.io/blowfish/samples/mathematical-notation/Fri, 08 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/mathematical-notation/<p>KaTeX can be used to render mathematical notation within articles.</p>Chartshttps://nunocoracao.github.io/blowfish/samples/charts/Wed, 06 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/charts/Blowfish includes Chart.js for powerful charts and data visualisations.Diagrams and Flowchartshttps://nunocoracao.github.io/blowfish/samples/diagrams-flowcharts/Wed, 06 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/diagrams-flowcharts/It&rsquo;s easy to add diagrams and flowcharts to articles using Mermaid.Emoji :parachute:https://nunocoracao.github.io/blowfish/samples/emoji/Tue, 05 Mar 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/emoji/📖🏞️🧗🏽🐉🧙🏽‍♂️🧚🏽👸An External Articlehttps://nunocoracao.github.io/blowfish/samples/external/Thu, 24 Jan 2019 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/external/The <code>externalUrl</code> front matter parameter can link to any URL. \ No newline at end of file diff --git a/docs/samples/thumbnail_sample/feature.jpg b/docs/samples/thumbnail_sample/feature.jpg new file mode 100644 index 00000000..e1a7b112 Binary files /dev/null and b/docs/samples/thumbnail_sample/feature.jpg differ diff --git a/docs/samples/thumbnail_sample/index.html b/docs/samples/thumbnail_sample/index.html new file mode 100644 index 00000000..2506bebf --- /dev/null +++ b/docs/samples/thumbnail_sample/index.html @@ -0,0 +1,36 @@ +Thumbnails · Blowfish + + + + + + + +

  1. Content Samples/

Thumbnails

·160 words·1 min·0 views

A quick example of how to start using Thumbnails in your articles.

If your average directory for an article looks like this:

content
+└── awesome_article.md
+

You need to change it from a single markdown file into a folder. Create a directory with the same name of the article, inside create a index.md file. You’ll get a structure similar to what’s below.

content
+└── awesome_article
+    └── featured.png
+

Inside the article you can now add an image file (almost all formats are supported bue we recommend .png or .jpg) that starts with feature*. Example below.

content
+└── awesome_article
+    ├── index.md
+    └── featured.png
+

This will tell Blowfish that this article has a feature image that can be used both as a thumbnail across your website as well as for oEmbed cards across social platforms. As an example, you can try copy pasting the URL of this article into a platform that shows oEmbeds (e.g. Twitter, WhatsApp, Telegram, etc) and see what is displayed.

© +2022 +Blowfish

Powered by Hugo & Blowfish

\ No newline at end of file diff --git a/docs/sitemap.xml b/docs/sitemap.xml index c606fde7..c9d4ddd1 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1 +1 @@ -https://nunocoracao.github.io/blowfish/posts/2022-06-13T20:55:37+01:00daily0.5https://nunocoracao.github.io/blowfish/2022-06-13T20:55:37+01:00daily0.5https://nunocoracao.github.io/blowfish/tags/docs/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/new/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/welcome/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/installation/2020-08-16T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/installation/2020-08-16T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/getting-started/2020-08-15T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/config/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/configuration/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/icons/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/icons/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/sample/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/shortcodes/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/users/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/users/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/homepage/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/homepage-layout/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/layouts/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/front-matter/2020-08-12T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/front-matter/2020-08-12T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/icon/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/lead/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/mermaid/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/shortcodes/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/analytics/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/comments/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/favicons/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/partials/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/partials/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/privacy/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/content/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/content-examples/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/example/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/advanced/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/advanced-customisation/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/css/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/deployment/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/github/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/hosting/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/hosting-deployment/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/netlify/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/render/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/firebase/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/firebase-views/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/views/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/html/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/markdown/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/markdown/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/gist/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/rich-content/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/twitter/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/vimeo/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/youtube/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/katex/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/mathematical-notation/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/maths/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/chart/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/charts/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/diagram/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/diagrams-flowcharts/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/graph/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/emoji/2019-03-05T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/emoji/2019-03-05T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/categories/daily0.5 \ No newline at end of file +https://nunocoracao.github.io/blowfish/samples/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/sample/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/thumbnail/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/thumbnail_sample/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/2022-09-26T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/posts/2022-06-13T20:55:37+01:00daily0.5https://nunocoracao.github.io/blowfish/tags/docs/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/new/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/welcome/2022-01-19T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/installation/2020-08-16T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/installation/2020-08-16T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/getting-started/2020-08-15T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/config/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/configuration/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/icons/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/icons/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/shortcodes/2022-03-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/users/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/users/2020-08-14T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/homepage/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/homepage-layout/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/layouts/2020-08-13T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/front-matter/2020-08-12T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/front-matter/2020-08-12T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/thumbnails/2020-08-12T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/icon/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/lead/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/mermaid/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/shortcodes/2020-08-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/analytics/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/comments/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/favicons/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/partials/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/partials/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/privacy/2020-08-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/content/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/content-examples/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/example/2020-08-09T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/advanced/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/advanced-customisation/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/css/2020-08-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/deployment/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/github/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/hosting/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/hosting-deployment/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/netlify/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/render/2020-08-07T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/firebase/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/docs/firebase-views/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/views/2020-08-03T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/html/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/markdown/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/markdown/2019-03-11T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/gist/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/rich-content/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/twitter/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/vimeo/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/youtube/2019-03-10T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/katex/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/mathematical-notation/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/maths/2019-03-08T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/chart/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/charts/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/diagram/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/diagrams-flowcharts/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/graph/2019-03-06T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/tags/emoji/2019-03-05T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/samples/emoji/2019-03-05T00:00:00+00:00daily0.5https://nunocoracao.github.io/blowfish/categories/daily0.5 \ No newline at end of file diff --git a/docs/tags/config/index.html b/docs/tags/config/index.html index ffd130de..836b7954 100644 --- a/docs/tags/config/index.html +++ b/docs/tags/config/index.html @@ -17,8 +17,8 @@

config

Configuration

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

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.

docs

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

2335 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

998 words·5 mins·0 views
In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality. +Installation # These instructions will get you up and running using Hugo and Blowfish from a completely blank state.

Getting Started

996 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

2434 words·12 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

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

Thumbnails

183 words·1 min·0 views
Thumbnails # Blowfish was enhanced in order to make it easy to add visual support to your posts. To do so, you just need to place an image file (almost all formats are supported bue we recommend .

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

998 words·5 mins·0 views
In addition to all the default Hugo shortcodes, Blowfish adds a few extras for additional functionality. Alert # alert outputs its contents as a stylised message box within your article. It’s useful for drawing attention to important information that you don’t want the reader to miss.

Partials

734 words·4 mins·0 views
Analytics # Blowfish provides built-in support for Fathom Analytics and Google Analytics. Fathom is a paid alternative to Google Analytics that respects user privacy. Fathom Analytics # To enable Fathom Analytics support, simply provide your Fathom site code in the config/_default/params.

Advanced Customisation

1519 words·8 mins·0 views
There are many ways you can make advanced changes to Blowfish. Read below to learn more about what can be customised and the best way of achieving your desired result.

Hosting & Deployment

822 words·4 mins·0 views
There are many ways to deploy your Hugo website built with Blowfish. The theme is designed to be flexible in almost any deployment scenario. Blowfish is built using relative URLs throughout the theme.

homepage

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.

installation

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.

Getting Started

996 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.
\ No newline at end of file diff --git a/docs/tags/layouts/index.html b/docs/tags/layouts/index.html index 9d4160ca..54aae947 100644 --- a/docs/tags/layouts/index.html +++ b/docs/tags/layouts/index.html @@ -17,7 +17,7 @@

layouts

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.

sample

Users

28 words·0 views
Real websites that are built with Blowfish. Website Details nunocoracao.com Personal site - Theme author Blowfish user? To add your site to this list, submit a pull request.

Icons

·144 words·1 min·0 views
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. +

sample

Thumbnails

·160 words·1 min·0 views
A quick example of how to start using Thumbnails in your artciles.

Users

28 words·0 views
Real websites that are built with Blowfish. Website Details nunocoracao.com Personal site - Theme author Blowfish user? To add your site to this list, submit a pull request.

Icons

·144 words·1 min·0 views
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. Additionally, custom icons are also fully supported.

Markdown

·472 words·3 mins·0 views

This article offers a sample of basic Markdown formatting that can be used in Blowfish, also it shows how some basic HTML elements are decorated.

Rich Content

·145 words·1 min·0 views
This is an example of a rich content summary.

Mathematical notation

·145 words·1 min·0 views

KaTeX can be used to render mathematical notation within articles.

Diagrams and Flowcharts

·250 words·2 mins·0 views
It’s easy to add diagrams and flowcharts to articles using Mermaid.

Charts

81 words·1 min·0 views
Blowfish includes Chart.js for powerful charts and data visualisations.

Emoji 🪂

·97 words·1 min·0 views
📖🏞️🧗🏽🐉🧙🏽‍♂️🧚🏽👸

© 2022 Blowfish

Powered by Hugo & Blowfish

\ No newline at end of file diff --git a/docs/tags/thumbnail/index.xml b/docs/tags/thumbnail/index.xml new file mode 100644 index 00000000..04480fa2 --- /dev/null +++ b/docs/tags/thumbnail/index.xml @@ -0,0 +1 @@ +thumbnail on Blowfishhttps://nunocoracao.github.io/blowfish/tags/thumbnail/Recent content in thumbnail on BlowfishHugo -- gohugo.ioenMon, 26 Sep 2022 00:00:00 +0000Thumbnailshttps://nunocoracao.github.io/blowfish/samples/thumbnail_sample/Mon, 26 Sep 2022 00:00:00 +0000https://nunocoracao.github.io/blowfish/samples/thumbnail_sample/A quick example of how to start using Thumbnails in your artciles.Thumbnailshttps://nunocoracao.github.io/blowfish/docs/thumbnails/Wed, 12 Aug 2020 00:00:00 +0000https://nunocoracao.github.io/blowfish/docs/thumbnails/Thumbnails # Blowfish was enhanced in order to make it easy to add visual support to your posts. To do so, you just need to place an image file (almost all formats are supported bue we recommend . \ No newline at end of file diff --git a/docs/tags/thumbnail/page/1/index.html b/docs/tags/thumbnail/page/1/index.html new file mode 100644 index 00000000..5e524899 --- /dev/null +++ b/docs/tags/thumbnail/page/1/index.html @@ -0,0 +1 @@ +https://nunocoracao.github.io/blowfish/tags/thumbnail/ \ No newline at end of file diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md index 6761c2d0..6b95d2a6 100644 --- a/exampleSite/content/docs/configuration/index.md +++ b/exampleSite/content/docs/configuration/index.md @@ -41,6 +41,12 @@ Note that the variable names provided in this table use dot notation to simplify |`taxonomies`|_Not set_|Refer to the [Organising content]({{< ref "getting-started#organising-content" >}}) section for taxonomy configuration.| +## Thumbnails + +Blowfish was built so it would be easy to add visual support to your articles. If your familiar with Hugo article strucutre, you just need to place an image file (almost all formats are supported bue we recommend `.png` or `.jpg`) that starts with `feature*` inside your article folder. And that's it, Blowfish will then able to both use the image as a thumbnail within your website as well as for oEmbed cards across social platforms. + +[Here]({{< ref "thumbnails" >}}) is also a guide with more info and a [sample]({{< ref "thumbnail_sample" >}}) if you want to see how you can do it. + ## Language and i18n Blowfish is optimised for full multilingual websites and theme assets are translated into several languages out of the box. The language configuration allows you to generate multiple versions of your content to provide a customised experience to your visitors in their native language. @@ -174,4 +180,4 @@ Many of the article defaults here can be overridden on a per article basis by sp The theme also includes a `markup.toml` configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Blowfish. -Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to fucntion incorrectly and could result in unintended behaviour. +Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to fucntion incorrectly and could result in unintended behaviour. \ No newline at end of file diff --git a/exampleSite/content/docs/getting-started/index.md b/exampleSite/content/docs/getting-started/index.md index 383424a4..c19aaa3d 100644 --- a/exampleSite/content/docs/getting-started/index.md +++ b/exampleSite/content/docs/getting-started/index.md @@ -159,6 +159,12 @@ Menu links will be sorted from lowest to highest `weight`, and then alphabetical Both menus are completely optional and can be commented out if not required. Use the template provided in the file as a guide. +## Thumbnails + +Blowfish was built so it would be easy to add visual support to your articles. If your familiar with Hugo article strucutre, you just need to place an image file (almost all formats are supported bue we recommend `.png` or `.jpg`) that starts with `feature*` inside your article folder. And that's it, Blowfish will then able to both use the image as a thumbnail within your website as well as for oEmbed cards across social platforms. + +[Here]({{< ref "thumbnails" >}}) is also a guide with more info and a [sample]({{< ref "thumbnail_sample" >}}) if you want to see how you can do it. + ## Detailed configuration The steps above are the bare minimum configuration. If you now run `hugo server` you will be presented with a blank Blowfish website. Detailed configuration is covered in the [Configuration]({{< ref "configuration" >}}) section. diff --git a/exampleSite/content/docs/homepage-layout/index.md b/exampleSite/content/docs/homepage-layout/index.md index 8d6dfdb0..627b92e0 100644 --- a/exampleSite/content/docs/homepage-layout/index.md +++ b/exampleSite/content/docs/homepage-layout/index.md @@ -50,3 +50,9 @@ All homepage layouts have the option of displaying recent articles below the mai ![Profile layout with recent articles](home-profile-list.png) The articles listed in this section are derived from the `mainSections` setting which allows for whatever content types you are using on your website. For instance, if you had content sections for _posts_ and _projects_ you could set this setting to `["posts", "projects"]` and all the articles in these two sections would be used to populate the recent list. The theme expects this setting to be an array so if you only use one section for all your content, you should set this accordingly: `["blog"]`. + +## Thumbnails + +Blowfish was built so it would be easy to add visual support to your articles. If your familiar with Hugo article strucutre, you just need to place an image file (almost all formats are supported bue we recommend `.png` or `.jpg`) that starts with `feature*` inside your article folder. And that's it, Blowfish will then able to both use the image as a thumbnail within your website as well as for oEmbed cards across social platforms. + +[Here]({{< ref "thumbnails" >}}) is also a guide with more info and a [sample]({{< ref "thumbnail_sample" >}}) if you want to see how you can do it. \ No newline at end of file diff --git a/exampleSite/content/docs/thumbnails/index.md b/exampleSite/content/docs/thumbnails/index.md new file mode 100644 index 00000000..1fc1217f --- /dev/null +++ b/exampleSite/content/docs/thumbnails/index.md @@ -0,0 +1,39 @@ +--- +title: "Thumbnails" +date: 2020-08-12 +draft: false +description: "Turn on thumbnails for your articles." +slug: "thumbnails" +tags: ["thumbnail", "config", "docs"] +--- + +## Thumbnails + +Blowfish was enhanced in order to make it easy to add visual support to your posts. To do so, you just need to place an image file (almost all formats are supported bue we recommend `.png` or `.jpg`) that starts with `feature*` inside your article main directory as shown in the example below. + +```shell +content +└── awesome_article + ├── index.md + └── featured.png +``` + +This will tell Blowfish that this article has a feature image that can be used both as a thumbnail across your website as well as for oEmbed cards across social platforms. + +## Folder Strucutre + +If you are using single `.md` files for your articles and have a file structure similar to this: + +```shell +content +└── awesome_article.md +``` + +You need to change it from a single markdown file into a folder. Create a directory with the same name of the article, inside create a `index.md` file. You'll get a structure similar to what's below. + +```shell +content +└── awesome_article + └── featured.png +``` +The you just need to add an image like explain earlier. If you want to see a sample of this you can consult [this sample]({{< ref "thumbnail_sample" >}}). \ No newline at end of file diff --git a/exampleSite/content/samples/thumbnail_sample/feature.jpg b/exampleSite/content/samples/thumbnail_sample/feature.jpg new file mode 100644 index 00000000..e1a7b112 Binary files /dev/null and b/exampleSite/content/samples/thumbnail_sample/feature.jpg differ diff --git a/exampleSite/content/samples/thumbnail_sample/index.md b/exampleSite/content/samples/thumbnail_sample/index.md new file mode 100644 index 00000000..c92c559a --- /dev/null +++ b/exampleSite/content/samples/thumbnail_sample/index.md @@ -0,0 +1,37 @@ +--- +title: "Thumbnails" +date: 2022-09-26 +draft: false +description: "Turn on thumbnails for your articles." +slug: "thumbnail_sample" +tags: ["thumbnail", "sample"] +summary: "A quick example of how to start using Thumbnails in your artciles." +--- + +A quick example of how to start using Thumbnails in your articles. + +If your average directory for an article looks like this: + +```shell +content +└── awesome_article.md +``` + +You need to change it from a single markdown file into a folder. Create a directory with the same name of the article, inside create a `index.md` file. You'll get a structure similar to what's below. + +```shell +content +└── awesome_article + └── featured.png +``` + +Inside the article you can now add an image file (almost all formats are supported bue we recommend `.png` or `.jpg`) that starts with `feature*`. Example below. + +```shell +content +└── awesome_article + ├── index.md + └── featured.png +``` + +This will tell Blowfish that this article has a feature image that can be used both as a thumbnail across your website as well as for oEmbed cards across social platforms. As an example, you can try copy pasting the URL of this article into a platform that shows oEmbeds (e.g. Twitter, WhatsApp, Telegram, etc) and see what is displayed.