Skip to main content
  1. Posts/

Short Code Example

2179 words·11 mins· loading · loading · ·
Table of Contents

Alert
#

{{< alert >}}
**Warning!** This action is destructive!
{{< /alert >}}
Warning! This action is destructive!

{{< alert cardColor="red" >}}
**Warning!** This action is destructive!
{{< /alert >}}
Warning! This action is destructive!

{{< alert textColor="red" >}}
**Warning!** This action is destructive!
{{< /alert >}}
Warning! This action is destructive!

{{< alert  "twitter" >}}
**Warning!** This action is destructive!
{{< /alert >}}
Do not forget to follow me

{{< alert  icon="fire" cardColor="#e63946" iconColor="#1d3557" textColor="#f1faee"  >}}
**Warning!** This action is destructive!
{{< /alert >}}
Do not forget to follow me

Article
#

{{< article link="/posts/002-macos-configuration/" >}}
macOS Setup for Development and Research
·3280 words·16 mins· loading · loading
MacOS Development

Badge
#

{{< badge >}}
New article!
{{< /badge >}}
New article!

Button
#

{{< button href="#button" target="_self" >}}
Call to action
{{< /button >}}
Call to action
{{< button href="https://blowfish.page/docs/shortcodes/#icon" target="_self" >}}
Call to action
{{< /button >}}
Open external links

Carousel#

carousel is used to showcase multiple images in an interactive and visually appealing way. This allows a user to slide through multiple images while only taking up the vertical space of a single one. All images are displayed using the full width of the parent component and using one of the predefined aspect ratios of 16:9, 21:9 or 32:9.

ParameterDescription
imagesRequired. A regex string to match image names.
aspectRatioOptional. The aspect ratio for the carousel. Either 16-9, 21-9 or 32-9. It is set to 16-9 by default.
intervalOptional. The interval for the auto-scrooling, specified in milliseconds. Defaults to 2000 (2s)
{{< carousel images="{gallery/03.jpg, gallery/01.jpg, gallery/02.jpg, gallery/04.jpg}" >}}

Example 2: 21:9 aspect ratio and regex-ed list of images

{{< carousel images="gallery/*" aspectRatio="21-9" interval="2500" >}}

Chart
#

chart uses the Chart.js library to embed charts into articles using simple structured data. It supports a number of different chart styles and everything can be configured from within the shortcode. Simply provide the chart parameters between the shortcode tags and Chart.js will do the rest.

Refer to the official Chart.js docs for details on syntax and supported chart types.

{{< chart >}}
type: 'bar',
data: {
  labels: ['Tomato', 'Blueberry', 'Banana', 'Lime', 'Orange'],
  datasets: [{
    label: '# of votes',
    data: [12, 19, 3, 5, 3],
  }]
}
{{< /chart >}}

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"
    caption="Photo by [Jr Korpa](https://unsplash.com/@jrkorpa) on [Unsplash](https://unsplash.com/)"
    >}}
Abstract purple artwork
Photo by Jr Korpa on Unsplash

![Abstract purple artwork](abstract.jpg "Photo by [Jr Korpa](https://unsplash.com/@jrkorpa) on [Unsplash](https://unsplash.com/)")

Abstract purple artwork
Photo by Jr Korpa on Unsplash

Gallery#

gallery allows you to showcase multiple images at once, in a responsive manner with more varied and interesting layouts.

In order to add images to the gallery, use img tags for each image and add class="grid-wXX" in order for the gallery to be able to identify the column width for each image. The widths available by default start at 10% and go all the way to 100% in 5% increments. For example, to set the width to 65%, set the class to grid-w65. Additionally, widths for 33% and 66% are also available in order to build galleries with 3 cols. You can also leverage tailwind’s responsive indicators to have a responsive grid.

{{< gallery >}}
<img src="gallery/01.jpg" class="grid-w33" />
<img src="gallery/02.jpg" class="grid-w33" />
<img src="gallery/03.jpg" class="grid-w33" />
<img src="gallery/04.jpg" class="grid-w33" />
<img src="gallery/05.jpg" class="grid-w33" />
<img src="gallery/06.jpg" class="grid-w33" />
<img src="gallery/07.jpg" class="grid-w33" />
{{< /gallery >}}

GitHub Card
#

github allows you to quickly link a github repository, all while showing and updating in realtime stats about it, such as the number of stars and forks it has.

ParameterDescription
repo[String] github repo in the format of username/repo
{{< github repo="cauliyang/cauliyang" >}}
cauliyang/cauliyang

null
1
1

GitLab Card
#

gitlab allows you to quickly link a GitLab Project (GitLab’s jargon for repo). It displays realtime stats about it, such as the number of stars and forks it has. Unlike github it can’t display the main programming language of a project. Finally custom GitLab instance URL can be provided, as long as the api/v4/projects/ endpoint is available, making this shortcode compatible with most self-hosted / entreprise deployments.

ParameterDescription
projectID[String] gitlab numeric ProjectID
baseURL[String] optional gitlab instance URL, default is https://gitlab.com/
{{< gitlab projectID="278964" >}}
GitLab.org / GitLab

GitLab is an open source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more. Self-host GitLab on your own servers, in a container, or on a cloud provider.

5101
9927

Icon
#

icon outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size.

Example:

{{< icon "github" >}}

Output:

Icons are populated using Hugo pipelines which makes them very flexible. Blowfish includes a number of built-in icons for social, links and other purposes. Check the icon samples page for a full list of supported icons. Custom icons can be added by providing your own icon assets in the assets/icons/ directory of your project. The icon can then be referenced in the shortcode by using the SVG filename without the .svg extension. Icons can also be used in partials by calling the icon partial.




Katex
#

The katex shortcode can be used to add mathematical expressions to article content using the KaTeX package. Refer to the online reference of supported TeX functions for the available syntax. To include mathematical expressions in an article, simply place the shortcode anywhere with the content. It only needs to be included once per article and KaTeX will automatically render any markup on that page. Both inline and block notation are supported. Inline notation can be generated by wrapping the expression in \\( and \\) delimiters. Alternatively, block notation can be generated using $$ delimiters.

Example:

{{< katex >}}
\\(f(a,b,c) = (a^2+b^2+c^2)^3\\)

\(f(a,b,c) = (a^2+b^2+c^2)^3\)

Lead
#

lead is used to bring emphasis to the start of an article. It can be used to style an introduction, or to call out an important piece of information. Simply wrap any Markdown content in the lead shortcode.

Example:

{{< lead >}}
When life gives you lemons, make lemonade.
{{< /lead >}}
When life gives you lemons, make lemonade.

List
#

List will display a list of recent articles. This shortcode requires a limit value to constraint the list. Additionally, it supports a where and a value in order to filter articles by their parameters. Note that this shortcode will not display its parent page but it will count for the limit value.

ParameterDescription
limitRequired. the number of recent articles to display.
titleOptional title for the list, default is Recent
whereThe variable to be used for the query of articles e.g. Type
valueThe value that will need to match the parameter defined in where for the query of articles e.g. for where == Type a valid value could be sample
The where and value values are used in the following query where .Site.RegularPages $where $value in the code of the shortcode. Check Hugo docs to learn more about which parameters are available to use.
{{< list limit=2 >}}

Recent

Aurora Is a Web Application for Visualizing Non-linear Graph
Visualization Graph Bioinformatics Data Structure
Notes from learning everything
Latex Learning

{{< list title="Samples" limit=5 where="Type" value="sample" >}}

Posts

Notes from learning everything
Latex Learning
CUDA for Deep Learning Inference in Rust and C++
1329 words·7 mins· loading · loading
Rust C++ CUDA
Development Tips
32 words·1 min· loading · loading
Development
Efficient Genomic Interval Search Using SIMD-Enhanced COITree
1412 words·7 mins· loading · loading
Rust Algorithm Bioinformatics
How to Use Noodles Library in Rust
2058 words·10 mins· loading · loading
Rust Bioinformatics

Mermaid
#

mermaid allows you to draw detailed diagrams and visualisations using text. It uses Mermaid under the hood and supports a wide variety of diagrams, charts and other output formats.

Simply write your Mermaid syntax within the mermaid shortcode and let the plugin do the rest.

Refer to the official Mermaid docs for details on syntax and supported diagram types.

Example:

{{< mermaid >}}
graph LR;
A[Lemons]-->B[Lemonade];
B-->C[Profit]
{{< /mermaid >}}
graph LR; A[Lemons]-->B[Lemonade]; B-->C[Profit]

Swatches
#

swatches outputs a set of up to three different colors to showcase color elements like a color palette. This shortcode takes the HEX codes of each color and creates the visual elements for each.

{{< swatches "#64748b" "#3b82f6" "#06b6d4" >}}

Output




Timeline
#

The timeline creates a visual timeline that can be used in different use-cases, e.g. professional experience, a project’s achievements, etc. The timeline shortcode relies on the timelineItem sub-shortcode to define each item within the main timeline. Each item can have the following properties.

ParameterDescription
iconthe icon to be used in the timeline visuals.
headerheader for each entry
badgetext to place within the top right badge
subheaderentry’s subheader

Example:

{{< timeline >}}

{{< timelineItem icon="github" header="header" badge="badge test" subheader="subheader" >}}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus non magna ex. Donec sollicitudin ut lorem quis lobortis. Name ac ipsum libero. Sed a ex eget ipsum tincidunt venenatis quis sed nisl. Pellentesque sed urna vel odio consequat tincidunt id ut purus. Name sollicitudin est sed dui interdum rhoncus.
{{< /timelineItem >}}

{{< timelineItem icon="code" header="Another Awesome Header" badge="date - present" subheader="Awesome Subheader" >}}
With html code

<ul>
  <li>Coffee</li>
  <li>Tea</li>
  <li>Milk</li>
</ul>
{{< /timelineItem >}}

{{< timelineItem icon="star" header="Shortcodes" badge="AWESOME" >}}
With other shortcodes
{{< gallery >}}
<img src="gallery/01.jpg" class="grid-w33" />
<img src="gallery/02.jpg" class="grid-w33" />
<img src="gallery/03.jpg" class="grid-w33" />
<img src="gallery/04.jpg" class="grid-w33" />
<img src="gallery/05.jpg" class="grid-w33" />
<img src="gallery/06.jpg" class="grid-w33" />
<img src="gallery/07.jpg" class="grid-w33" />
{{< /gallery >}}
{{< /timelineItem >}}

{{< /timeline >}}
  1. header

    badge test

    subheader

    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus non magna ex. Donec sollicitudin ut lorem quis lobortis. Name ac ipsum libero. Sed a ex eget ipsum tincidunt venenatis quis sed nisl. Pellentesque sed urna vel odio consequat tincidunt id ut purus. Name sollicitudin est sed dui interdum rhoncus.
  2. Another Awesome Header

    date - present

    Awesome Subheader

    With html code
    • Coffee
    • Tea
    • Milk
  3. Shortcodes

    AWESOME

    With other shortcodes

TypeIt
#

TypeIt is the most versatile JavaScript tool for creating typewriter effects on the planet. With a straightforward configuration, it allows you to type single or multiple strings that break lines, delete & replace each other, and it even handles strings that contain complex HTML.

Blowfish implements a sub-set of TypeIt features using a shortcode. Write your text within the typeit shortcode and use the following parameters to configure the behavior you want.

ParameterDescription
tag[String] html tag that will be used to render the strings.
classList[String] List of css classes to apply to the html element.
initialString[String] Initial string that will appear written and will be replaced.
speed[number] Typing speed, measured in milliseconds between each step.
lifeLike[boolean] Makes the typing pace irregular, as if a real person is doing it.
startDelay[number] The amount of time before the plugin begins typing after being initialized.
breakLines[boolean] Whether multiple strings are printed on top of each other (true), or if they’re deleted and replaced by each other (false).
waitUntilVisible[boolean] Determines if the instance will begin when loaded or only when the target element becomes visible in the viewport. The default is true
loop[boolean] Whether your strings will continuously loop after completing

Example 1:

{{< typeit >}}
Lorem ipsum dolor sit amet
{{< /typeit >}}

Example 2:

{{< typeit tag=h1 lifeLike=true >}}
Lorem ipsum dolor sit amet,
consectetur adipiscing elit.
{{< /typeit >}}

Example 3:

{{< typeit
  tag=h3
  speed=50
  breakLines=false
  loop=true
>}}
Lorem ipsum dolor sit amet,
consectetur adipiscing elit.
{{< /typeit >}}

Embed PDF
#

    / [pdf]

Related

C++ Development in Bioinformatics
1197 words·6 mins· loading · loading
Develop C++