Skip to main content

Series

<time datetime="2023-08-19 21:44:35 -0500 CDT">Updated: August 19 2023</time><span class="px-2 text-primary-500">&middot;</span><span>228 words</span><span class="px-2 text-primary-500">&middot;</span><span title="Reading time">2 mins</span>
Series Docs
Documentation - This article is part of a series.
Part 11: This Article

Blowfish provides a feature to group a set of articles together under a “series”. Placing an article under a series will display the rest of the series articles in each single page and provide a quick way to navigate amongst them. You can see an example of this above.

Create Taxonomy #

The first step to enable series is to create the series taxonomy. For doing this just add the series taxonomy to your taxonomy list in the config.toml.

[taxonomies]
  tag = "tags"
  category = "categories"
  author = "authors"
  series = "series"

Mark Articles #

Then you just need to mark each article using the series parameter and the series_order. The series parameter will be the id and name of the series you are placing the article into (even though the variable is an array we recommend keeping each article to a single series.). And the series_order defines the order of that article within the series. In the example below the article is number 11 in the Documentation series.

series: ["Documentation"]
series_order: 11

Series Behavior #

Marking an article as part of a series will automatically display the series module as you see in this page for example. You can choose whether that module starts opened or not using the article.seriesOpened global variable in params.toml or the front-matter parameter seriesOpened to specify an override at the article level.

Documentation - This article is part of a series.
Part 11: This Article