mirror of
https://github.com/nunocoracao/blowfish.git
synced 2026-01-30 16:31:52 +01:00
updated docs for v1 and polished some minor fixes across the code
This commit is contained in:
Nuno Coração
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Content Samples"
|
||||
description: "See what's possible with Congo."
|
||||
description: "See what's possible with Blowfish."
|
||||
|
||||
cascade:
|
||||
showEdit: false
|
||||
@@ -8,11 +8,11 @@ cascade:
|
||||
---
|
||||
|
||||
{{< lead >}}
|
||||
Congo brings your content to life. :heart_eyes:
|
||||
Blowfish brings your content to life. :heart_eyes:
|
||||
{{< /lead >}}
|
||||
|
||||
This section contains some demo pages that show how Congo renders different types of content. You can also see an example [taxonomy listing]({{< ref "tags" >}}) page.
|
||||
This section contains some demo pages that show how Blowfish renders different types of content. You can also see an example [taxonomy listing]({{< ref "tags" >}}) page.
|
||||
|
||||
_**Sidenote:** This page is just a standard Congo article listing and Hugo has been configured to generate a `samples` content type and display article summaries._
|
||||
_**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._
|
||||
|
||||
---
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
title: "Charts"
|
||||
date: 2019-03-06
|
||||
description: "Guide to Chart.js usage in Congo"
|
||||
summary: "Congo includes Chart.js for powerful charts and data visualisations."
|
||||
description: "Guide to Chart.js usage in Blowfish"
|
||||
summary: "Blowfish includes Chart.js for powerful charts and data visualisations."
|
||||
tags: ["chart", "sample", "graph", "shortcodes"]
|
||||
showDate: false
|
||||
---
|
||||
|
||||
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.
|
||||
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]({{< ref "docs/shortcodes#chart" >}}) docs for more details.
|
||||
|
||||
The examples below are a small selection taken from the [official Chart.js docs](https://www.chartjs.org/docs/latest/samples). You can also [view the page source](https://raw.githubusercontent.com/jpanther/congo/dev/exampleSite/content/samples/charts.md) on GitHub to see the markup.
|
||||
The examples below are a small selection taken from the [official Chart.js docs](https://www.chartjs.org/docs/latest/samples). You can also [view the page source](https://raw.githubusercontent.com/nunocoracao/blowfish/main/exampleSite/content/samples/charts.md) on GitHub to see the markup.
|
||||
|
||||
## Bar chart
|
||||
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
title: "Diagrams and Flowcharts"
|
||||
date: 2019-03-06
|
||||
description: "Guide to Mermaid usage in Congo"
|
||||
description: "Guide to Mermaid usage in Blowfish"
|
||||
summary: "It's easy to add diagrams and flowcharts to articles using Mermaid."
|
||||
tags: ["mermaid", "sample", "diagram", "shortcodes"]
|
||||
---
|
||||
|
||||
Mermaid diagrams are supported in Congo using the `mermaid` shortcode. Simply wrap the diagram markup within the shortcode. Congo automatically themes Mermaid diagrams to match the configured `colorScheme` parameter.
|
||||
Mermaid diagrams are supported in Blowfish using the `mermaid` shortcode. Simply wrap the diagram markup within the shortcode. Blowfish automatically themes Mermaid diagrams to match the configured `colorScheme` parameter.
|
||||
|
||||
Refer to the [mermaid shortcode]({{< ref "docs/shortcodes#mermaid" >}}) docs for more details.
|
||||
|
||||
The examples below are a small selection taken from the [official Mermaid docs](https://mermaid-js.github.io/mermaid/). You can also [view the page source](https://raw.githubusercontent.com/jpanther/congo/dev/exampleSite/content/samples/diagrams-flowcharts.md) on GitHub to see the markup.
|
||||
The examples below are a small selection taken from the [official Mermaid docs](https://mermaid-js.github.io/mermaid/). You can also [view the page source](https://raw.githubusercontent.com/nunocoracao/blowfish/main/exampleSite/content/samples/diagrams-flowcharts.md) on GitHub to see the markup.
|
||||
|
||||
## Flowchart
|
||||
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
---
|
||||
title: "Emoji :parachute:"
|
||||
date: 2019-03-05
|
||||
description: "Guide to Emoji usage in Congo"
|
||||
description: "Guide to Emoji usage in Blowfish"
|
||||
summary: "📖🏞️🧗🏽🐉🧙🏽♂️🧚🏽👸"
|
||||
tags: ["emoji", "sample"]
|
||||
---
|
||||
|
||||
Emoji is supported throughout Congo by default. Emoji can be used in titles, menu items and article content.
|
||||
Emoji is supported throughout Blowfish by default. Emoji can be used in titles, menu items and article content.
|
||||
|
||||
{{< alert >}}
|
||||
**Note:** The rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack.
|
||||
{{< /alert >}}
|
||||
|
||||
Emoji replacements are automatic throughout Congo, so you can use shorthand codes in your content and front matter and they will be converted to their corresponding symbols at build time.
|
||||
Emoji replacements are automatic throughout Blowfish, so you can use shorthand codes in your content and front matter and they will be converted to their corresponding symbols at build time.
|
||||
|
||||
**Example:** `see_no_evil` :see_no_evil:, `hear_no_evil` :hear_no_evil:, `speak_no_evil` :speak_no_evil:.
|
||||
|
||||
|
||||
@@ -3,13 +3,12 @@ title: "Icons"
|
||||
date: 2020-08-14
|
||||
lastmod: 2022-03-09
|
||||
draft: false
|
||||
description: "Icon support in Congo."
|
||||
description: "Icon support in Blowfish."
|
||||
slug: "icons"
|
||||
tags: ["icons", "sample", "shortcodes"]
|
||||
showDateUpdated: true
|
||||
---
|
||||
|
||||
Congo has built-in support for a number of [FontAwesome 6](https://fontawesome.com/icons) icons. These can be included in your website through either the [icon partial]({{< ref "docs/partials#icon" >}}) or [icon shortcode]({{< ref "docs/shortcodes#icon" >}}).
|
||||
Blowfish has built-in support for a number of [FontAwesome 6](https://fontawesome.com/icons) icons. These can be included in your website through either the [icon partial]({{< ref "docs/partials#icon" >}}) or [icon shortcode]({{< ref "docs/shortcodes#icon" >}}).
|
||||
|
||||
Additionally, custom icons are also fully supported. Simply provide your own SVG icon assets by placing them in the `assets/icons/` directory in the root of your project. Any icons in the icons directory will then be available to use throughout the theme.
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ description: "Sample article showcasing basic Markdown syntax and formatting for
|
||||
tags: ["markdown", "css", "html", "sample"]
|
||||
---
|
||||
|
||||
This article offers a sample of basic Markdown formatting that can be used in Congo, also it shows how some basic HTML elements are decorated.
|
||||
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.
|
||||
|
||||
<!--more-->
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Mathematical notation
|
||||
date: 2019-03-08
|
||||
description: A brief sample of mathematical notation in Congo.
|
||||
description: A brief sample of mathematical notation in Blowfish.
|
||||
tags: ["sample", "katex", "maths", "shortcodes"]
|
||||
---
|
||||
|
||||
@@ -11,7 +11,7 @@ KaTeX can be used to render mathematical notation within articles.
|
||||
|
||||
{{< katex >}}
|
||||
|
||||
Congo will only bundle the KaTeX assets into your project if you make use of mathematical notation. In order for this to work, simply include the [`katex` shortcode]({{< ref "docs/shortcodes#katex" >}}) within the article. Any KaTeX syntax on that page will then be automatically rendered.
|
||||
Blowfish will only bundle the KaTeX assets into your project if you make use of mathematical notation. In order for this to work, simply include the [`katex` shortcode]({{< ref "docs/shortcodes#katex" >}}) within the article. Any KaTeX syntax on that page will then be automatically rendered.
|
||||
|
||||
Use the online reference of [supported TeX functions](https://katex.org/docs/supported.html) for the available syntax.
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ Alternatively, the `tweet` shortcode can be used to embed a fully marked up Twit
|
||||
|
||||
The `gist` shortcode can be used to embed a GitHub Gist. It requires two unnamed parameters: the username and ID of the Gist.
|
||||
|
||||
{{< gist jpanther a873e1219ffeaa80a926bbe8255f348e >}}
|
||||
{{< gist nunocoracao 2779792841f7ffa7c7e62dc4d38626d4 >}}
|
||||
|
||||
## Vimeo
|
||||
|
||||
|
||||
Reference in New Issue
Block a user