CINXE.COM

<!doctype html><html lang=en><head><meta charset=UTF-8><meta content="default-src 'self';font-src 'self' data: 'self';img-src 'self' https://* data:;media-src 'self' https://cdn.jsdelivr.net/;style-src 'self' 'unsafe-inline';frame-src player.vimeo.com https://www.youtube-nocookie.com;connect-src 'self' https://tabi-stats.osc.garden;script-src 'self' https://tabi-stats.osc.garden 'self'" http-equiv=Content-Security-Policy><meta content="width=device-width,initial-scale=1.0" name=viewport><meta content=https://welpo.github.io/tabi name=base><title>~/tabi • A Complete Guide to Series</title><link href=https://welpo.github.io/tabi/img/seedling.png rel=icon type=image/png><link href='data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><text y="50%" x="50%" dominant-baseline="central" text-anchor="middle" font-size="88">🌱</text></svg>' rel=icon><link title="~/tabi - Atom Feed" href=https://welpo.github.io/tabi/atom.xml rel=alternate type=application/atom+xml><link href="https://welpo.github.io/tabi/custom_subset.css?h=0b9535a28bc3d5bf2321" rel=stylesheet><link href="https://welpo.github.io/tabi/main.css?h=98c8cfb580fe7a59eb13" rel=stylesheet><meta content="light dark" name=color-scheme><meta content=#087e96 name=theme-color><meta content="Learn how to organize your posts into sequential series, perfect for tutorials, courses, and multi-part stories." name=description><meta content="Learn how to organize your posts into sequential series, perfect for tutorials, courses, and multi-part stories." property=og:description><meta content="A Complete Guide to Series" property=og:title><meta content=article property=og:type><meta content="https://welpo.github.io/tabi/blog/series/social_cards/es_blog_series.jpg?h=d4b64d21ea2e4633bb8c" property=og:image><meta content=1400 property=og:image:width><meta content=800 property=og:image:height><meta content="https://welpo.github.io/tabi/blog/series/social_cards/es_blog_series.jpg?h=d4b64d21ea2e4633bb8c" name=twitter:image><meta content=summary_large_image name=twitter:card><meta content=ca_ES property=og:locale:alternate><link href=https://welpo.github.io/tabi/ca/blog/series/ hreflang=ca rel=alternate><meta content=es_ES property=og:locale:alternate><link href=https://welpo.github.io/tabi/es/blog/series/ hreflang=es rel=alternate><meta content=en_GB property=og:locale:alternate><link href=https://welpo.github.io/tabi/blog/series/ hreflang=en rel=alternate><meta content=https://welpo.github.io/tabi/blog/series/ property=og:url><meta content=~/tabi property=og:site_name><noscript><link href=https://welpo.github.io/tabi/no_js.css rel=stylesheet></noscript><script src=https://welpo.github.io/tabi/js/initializeTheme.min.js></script><script defer src=https://welpo.github.io/tabi/js/themeSwitcher.min.js></script><script async data-goatcounter=https://tabi-stats.osc.garden/count src=https://tabi-stats.osc.garden/count.js></script><script src="https://welpo.github.io/tabi/js/searchElasticlunr.min.js?h=3626c0ef99daa745b31e" defer></script><body><header><nav class=navbar><div class=nav-title><a class=home-title href=https://welpo.github.io/tabi>~/tabi</a></div><div class=nav-navs><ul><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/blog/>blog </a><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/archive/>archive </a><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/tags/>tags </a><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/projects/>projects </a><li class=menu-icons-container><ul class=menu-icons-group><li class="js menu-icon"><div aria-label="Click or press $SHORTCUT to open search" class="search-icon interactive-icon" title="Click or press $SHORTCUT to open search" id=search-button role=button tabindex=0><svg viewbox="0 -960 960 960" xmlns=http://www.w3.org/2000/svg><path d="M784-120 532-372q-30 24-69 38t-83 14q-109 0-184.5-75.5T120-580q0-109 75.5-184.5T380-840q109 0 184.5 75.5T640-580q0 44-14 83t-38 69l252 252-56 56ZM380-400q75 0 127.5-52.5T560-580q0-75-52.5-127.5T380-760q-75 0-127.5 52.5T200-580q0 75 52.5 127.5T380-400Z"/></svg></div><li class=language-switcher><details class=dropdown><summary aria-label="Language selection" title="Language selection" aria-haspopup=true role=button><div class=language-switcher-icon></div></summary> <div class=dropdown-content role=menu>English<a aria-label=العربية href=https://welpo.github.io/tabi/ar/blog/series/ lang=ar role=menuitem>العربية</a><a aria-label=Español href=https://welpo.github.io/tabi/es/blog/series/ lang=es role=menuitem>Español</a><a aria-label=Català href=https://welpo.github.io/tabi/ca/blog/series/ lang=ca role=menuitem>Català</a></div></details><li class="theme-switcher-wrapper js"><div aria-label="Toggle dark mode" title="Toggle dark/light mode" aria-pressed=false class=theme-switcher role=button tabindex=0></div><div aria-label="Reset mode to default" class="theme-resetter arrow" title="Reset mode to default" aria-hidden=true role=button tabindex=0></div></ul></ul></div></nav></header><div class=content><main><article><h1 class=article-title>A Complete Guide to Series</h1><ul class=meta><li>8th Nov 2024<li title="1597 words">•8 min read<li class=tag>•Tags: <li class=tag><a href=https://welpo.github.io/tabi/tags/showcase/>showcase</a>, <li class=tag><a href=https://welpo.github.io/tabi/tags/tutorial/>tutorial</a>, <li class=tag><a href=https://welpo.github.io/tabi/tags/faq/>FAQ</a>, <li class=tag><a href=https://welpo.github.io/tabi/tags/series/>series</a></ul><ul class="meta last-updated"><li>Updated on 15th Feb 2025<li>•<a class=external href=https://github.com/welpo/tabi/commits/main/content/blog/series/index.md>See changes</a></ul><div class=toc-container><h3>Table of Contents</h3><ul><li><a href=https://welpo.github.io/tabi/blog/series/#quick-start>Quick Start</a><li><a href=https://welpo.github.io/tabi/blog/series/#how-do-series-work>How Do Series Work?</a><li><a href=https://welpo.github.io/tabi/blog/series/#jump-to-posts>Jump to Posts</a><li><a href=https://welpo.github.io/tabi/blog/series/#series-pages-and-order>Series Pages and Order</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#sorting-options>Sorting Options</a><li><a href=https://welpo.github.io/tabi/blog/series/#page-indexing>Page Indexing</a></ul><li><a href=https://welpo.github.io/tabi/blog/series/#intro-and-outro-templates>Intro and Outro Templates</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#template-types>Template Types</a><li><a href=https://welpo.github.io/tabi/blog/series/#placement-in-content>Placement in Content</a></ul><li><a href=https://welpo.github.io/tabi/blog/series/#variables>Variables</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#basic-series-variables>Basic Series Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#navigation-variables>Navigation Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#first-article-reference>First Article Reference</a><li><a href=https://welpo.github.io/tabi/blog/series/#template-example>Template Example</a><li><a href=https://welpo.github.io/tabi/blog/series/#custom-variables>Custom Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#using-custom-variables>Using Custom Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#example-with-custom-variables>Example with Custom Variables</a></ul></ul></div><section class=body>A series organizes related posts in a sequential order, similar to chapters in a book. Unlike tags, which simply group related content, series suggest a specific reading order from start to finish.Posts within a series do not need to be published consecutively; the series feature brings together thematically linked posts in a coherent sequence.The diagram below illustrates how series posts (3, 5, and 8) exist within the main blog flow while maintaining their own ordered sequence within Series 1.<noscript>⚠️ JavaScript is required to render the diagram.</noscript><pre class="mermaid invertible-image full-width"> flowchart subgraph main[BLOG] P1[Post 1] P2[P2] P3[P3] P4[P4] P5[P5] P6[P6] P7[P7] P8[P8] P9[P9] end subgraph series1[SERIES 1] PS1["Series Post 1 (=P3)"] PS2["Series Post 2 (=P5)"] PS3["Series Post 3 (=P8)"] end P3 o-.-o PS1 P5 o-.-o PS2 P8 o-.-o PS3 </pre><h2 id=quick-start><a aria-label="Anchor link for: quick-start" class="header-anchor no-hover-padding" href=#quick-start></a> Quick Start</h2><ol><li>Create a directory for your series.<li>Create <code>_index.md</code> in the series directory.<li>Set up the <code>_index.md</code> front matter: <pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md>title = "Learning Rust" template = "series.html" sort_by = "slug" transparent = true [extra] series = true </code></pre><li>Create your series articles in this directory.</ol>Want more? Keep reading!<h2 id=how-do-series-work><a aria-label="Anchor link for: how-do-series-work" class="header-anchor no-hover-padding" href=#how-do-series-work></a> How Do Series Work?</h2>A series is just a section which is handled in a special way by tabi. For more details on sections, see the <a class=external href=https://www.getzola.org/documentation/content/section/>Zola documentation</a>.Taking the example from the diagram above, the directory structure would be as follow:<pre class="language-txt z-code" data-lang=txt><code class=language-txt data-lang=txt>content/ _index.md blog/ _index.md post1/ index.md post2/ index.md post4/ index.md post6/ index.md post7/ index.md post9/ index.md series1/ _index.md post3/ index.md post5/ index.md post8/ index.md </code></pre>To create a series, you need to:<ol><li>Use the <code>series.html</code> template<li>Set <code>series = true</code> in the section’s <code>[extra]</code> configuration<li>Enable <code>transparent = true</code> to integrate series posts with the parent blog section</ol>The series main page displays an overview followed by a list of all posts in the series:<div class=full-width><img alt="a series" class=img-light loading=lazy src=https://welpo.github.io/tabi/blog/series/img/series_light.webp><img alt="a series" class=img-dark loading=lazy src=https://welpo.github.io/tabi/blog/series/img/series_dark.webp></div><h2 id=jump-to-posts><a aria-label="Anchor link for: jump-to-posts" class="header-anchor no-hover-padding" href=#jump-to-posts></a> Jump to Posts</h2>If the content of a series (the Markdown after the front matter in <code>_index.md</code>) is over 2000 characters, a “Jump to posts” link appears next to the series title.<div class=full-width><img alt="jump to series posts link" class=img-light loading=lazy src=https://welpo.github.io/tabi/blog/series/img/jump_to_series_posts_light.webp><img alt="jump to series posts link" class=img-dark loading=lazy src=https://welpo.github.io/tabi/blog/series/img/jump_to_series_posts_dark.webp></div>To force the feature on or off, set <code>show_jump_to_posts</code> in the <code>[extra]</code> section of your series section or in <code>config.toml</code>. This setting follows <a href=https://welpo.github.io/tabi/blog/mastering-tabi-settings/#settings-hierarchy>the hierarchy</a>.<h2 id=series-pages-and-order><a aria-label="Anchor link for: series-pages-and-order" class="header-anchor no-hover-padding" href=#series-pages-and-order></a> Series Pages and Order</h2>All pages in the series section will be a series page. The series pages will be ordered as per the series section <code>sort_by</code>.While series maintain their own internal order, they remain independent from the main section’s (e.g. <code>blog/</code>) chronological flow thanks to the <code>transparent</code> setting.<h3 id=sorting-options><a aria-label="Anchor link for: sorting-options" class="header-anchor no-hover-padding" href=#sorting-options></a> Sorting Options</h3>Choose from these sorting methods, each with its own advantages:<div class=full-width><table><thead><tr><th><code>sort_by</code><th>pros<th>cons<tbody><tr><td><code>slug</code><td>The series pages order is made explicit in the path (e.g. <code>example.com/blog/series1/01-series-post-one</code>).<td>Each series page must be prefixed accordingly.<tr><td><code>weight</code><td>The series pages order is easy to set up transparently. First series post has weight <code>1</code>, second series post has weight <code>2</code> and so on.<td>Each series page must have its weight set accordingly.<tr><td><code>date</code><td>The series pages order can be configured once in the series section configuration. No need to do anything on each series page.<td>The series pages order has to be reversed because the first page is usually the oldest. This can only be achieved by paginating the series section (<code>paginate_by = 9999</code>) and reversing its order (<code>paginate_reversed = true</code>).</table></div><div class="admonition danger"><div class="admonition-icon admonition-icon-danger"></div><div class=admonition-content>Zola version to sort by dateIn order to properly reverse dates, Zola v0.19.3+ (unreleased) is required so that pagination information is available through the <code>get_section</code> function. Anything relying on the series pages order won’t be correct in a series page otherwise (e.g. previous/next series page, ordered and unordered list…) See <a class=external href=https://github.com/getzola/zola/pull/2653>Zola PR #2653</a>.</div></div><h3 id=page-indexing><a aria-label="Anchor link for: page-indexing" class="header-anchor no-hover-padding" href=#page-indexing></a> Page Indexing</h3>Pages in a series are indexed starting from 1, following their <code>sort_by</code> order. To reverse the indexing (making the first page have the highest index instead), add this setting to <code>_index.md</code> or <code>config.toml</code>:<pre class="language-toml z-code" data-lang=toml><code class=language-toml data-lang=toml>[extra] post_listing_index_reversed = true # Defaults to false if unset. </code></pre><div class=full-width><img alt="a series with indexes reversed" class=img-light loading=lazy src=https://welpo.github.io/tabi/blog/series/img/series_reversed_light.webp><img alt="a series with indexes reversed" class=img-dark loading=lazy src=https://welpo.github.io/tabi/blog/series/img/series_reversed_dark.webp></div>This setting follows <a href=https://welpo.github.io/tabi/blog/mastering-tabi-settings/#settings-hierarchy>the hierarchy</a>.<h2 id=intro-and-outro-templates><a aria-label="Anchor link for: intro-and-outro-templates" class="header-anchor no-hover-padding" href=#intro-and-outro-templates></a> Intro and Outro Templates</h2>Series articles can have automatic introduction and conclusion sections. These are configured in your series’ <code>_index.md</code>. A basic example:<pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md>[extra.series_intro_templates] default = "This article is part of the $SERIES_HTML_LINK series." [extra.series_outro_templates] default = "Thanks for reading part $SERIES_PAGE_INDEX of $SERIES_HTML_LINK!" </code></pre>The intro and outro sections each have their own CSS classes (<code>series-page-intro</code> and <code>series-page-outro</code>), allowing you to customize their appearance through <a href=https://welpo.github.io/tabi/blog/mastering-tabi-settings/#custom-css>custom CSS</a>.<h3 id=template-types><a aria-label="Anchor link for: template-types" class="header-anchor no-hover-padding" href=#template-types></a> Template Types</h3>The series system uses different templates based on an article’s position in the series:<ul><li><code>next_only</code> - Used for the first article (has next article but no previous)<li><code>middle</code> - Used for articles with both previous and next articles<li><code>prev_only</code> - Used for the last article (has previous article but no next)<li><code>default</code> - Fallback template used when a specific position template isn’t defined</ul>The system automatically determines which template to use based on the article’s position. The templates are defined in the series configuration (<code>_index.md</code>), as <code>extra.series_intro_templates</code> and <code>extra.series_outro_templates</code>.:<pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md>[extra.series_intro_templates] next_only = "Welcome to part 1! Next up: $NEXT_HTML_LINK" middle = "Previous: $PREV_HTML_LINK | Next: $NEXT_HTML_LINK" prev_only = "The final chapter! Previously: $PREV_HTML_LINK" default = "Part $SERIES_PAGE_INDEX of $SERIES_PAGES_NUMBER" </code></pre>All templates are optional. Template selection follows a priority system:<ol><li>If a position-specific template exists (<code>next_only</code>, <code>middle</code>, or <code>prev_only</code>), it will be used<li>Otherwise, the <code>default</code> template is used<li>If no templates are defined at all, no series information will be displayed</ol>See the <a href=https://welpo.github.io/tabi/blog/series/#template-example>template example</a> for a more elaborate example.<h3 id=placement-in-content><a aria-label="Anchor link for: placement-in-content" class="header-anchor no-hover-padding" href=#placement-in-content></a> Placement in Content</h3>By default:<ul><li>Series introductions appear at the start of your article<li>Series outro appears at the end (before footnotes, if any)</ul>You can control exactly where these appear using <code>&LT!-- series_intro --></code> and <code>&LT!-- series_outro --></code> in your Markdown:<pre class="language-markdown z-code" data-lang=markdown><code class=language-markdown data-lang=markdown>This paragraph appears before the series introduction. &LT!-- series_intro --> Main content of the article. &LT!-- series_outro --> ## Learning Resources Extra content… [^1]: Footnotes will always appear at the end. </code></pre><h2 id=variables><a aria-label="Anchor link for: variables" class="header-anchor no-hover-padding" href=#variables></a> Variables</h2>Series templates use a flexible variable system that lets you:<ol><li>Reference series information (title, links)<li>Add navigation between articles<li>Show progress indicators<li>Include custom information using your own variables</ol>Variables are placeholders starting with <code>$</code> that get replaced with actual content when your site builds. For example, <code>$SERIES_HTML_LINK</code> becomes a clickable link to your series index page.There are three types of variables:<ul><li><a href=https://welpo.github.io/tabi/blog/series/#basic-series-variables>Basic Series Variables</a>: General information about the series<li><a href=https://welpo.github.io/tabi/blog/series/#navigation-variables>Navigation Variables</a>: Links to previous/next articles<li><a href=https://welpo.github.io/tabi/blog/series/#custom-variables>Custom Variables</a>: Your own placeholders for additional information</ul><h3 id=basic-series-variables><a aria-label="Anchor link for: basic-series-variables" class="header-anchor no-hover-padding" href=#basic-series-variables></a> Basic Series Variables</h3><div class=full-width><table><thead><tr><th>Variable<th>Availability<th>Returns<th>Description<th>Example Usage<th>Example Output<tbody><tr><td><code>$SERIES_TITLE</code><td>Always<td>Text<td>Plain text title of the series<td><code>Part of $SERIES_TITLE</code><td>Part of Learn Rust<tr><td><code>$SERIES_PERMALINK</code><td>Always<td>Text<td>URL to series index<td><code>[See all posts]($SERIES_PERMALINK)</code><td><a href=/series/learn-rust>See all posts</a><tr><td><code>$SERIES_HTML_LINK</code><td>Always<td>HTML<td>Ready-to-use link to series<td><code>Welcome to $SERIES_HTML_LINK!</code><td>Welcome to <a href=/series/learn-rust>Learn Rust</a>!<tr><td><code>$SERIES_PAGES_NUMBER</code><td>Always<td>Number<td>Total articles in series<td><code>A $SERIES_PAGES_NUMBER part series</code><td>A 5 part series<tr><td><code>$SERIES_PAGE_INDEX</code><td>Always<td>Number<td>Current article’s position<td><code>Part $SERIES_PAGE_INDEX of $SERIES_PAGES_NUMBER</code><td>Part 3 of 5<tr><td><code>$SERIES_PAGES_OLIST</code><td>Always<td>HTML<td>Ordered list of all articles<td><code>Articles in series: $SERIES_PAGES_OLIST</code><td>Articles in series: <ol><li>Current article<li><a href=...>Other articles</a></ol><tr><td><code>$SERIES_PAGES_ULIST</code><td>Always<td>HTML<td>Unordered list of all articles<td><code>Articles in series: $SERIES_PAGES_ULIST</code><td>Articles in series: <ul><li>Current article<li><a href=...>Other articles</a></ul></table></div><div class="admonition tip"><div class="admonition-icon admonition-icon-tip"></div><div class=admonition-content>TIP: Custom text with permalinksMarkdown links like <code>[text]($SERIES_PERMALINK)</code> will be marked (and <a href=https://welpo.github.io/tabi/blog/mastering-tabi-settings/#external-link-indicator>styled</a>) as external. If you need custom text and want to avoid external styling, use HTML: <code>&LTa href=\"$SERIES_PERMALINK\">your text&LT/a></code>.</div></div><h3 id=navigation-variables><a aria-label="Anchor link for: navigation-variables" class="header-anchor no-hover-padding" href=#navigation-variables></a> Navigation Variables</h3><div class=full-width><table><thead><tr><th>Variable<th>Availability<th>Returns<th>Description<th>Example Usage<th>Example Output<tbody><tr><td><code>$PREV_TITLE</code><td>Previous exists<td>Text<td>Previous article’s title<td><code>Previously: $PREV_TITLE</code><td>Previously: Setting Up Your Environment<tr><td><code>$PREV_PERMALINK</code><td>Previous exists<td>Text<td>URL to previous article<td><code>[← Back]($PREV_PERMALINK)</code><td><a href=/series/learn-rust/setup>← Back</a><tr><td><code>$PREV_HTML_LINK</code><td>Previous exists<td>HTML<td>Ready-to-use link to previous<td><code>Read $PREV_HTML_LINK first</code><td>Read <a href=/series/learn-rust/setup>Setting Up Your Environment</a> first<tr><td><code>$PREV_DESCRIPTION</code><td>Previous exists<td>Text<td>Description of previous article<td><code>Recap: $PREV_DESCRIPTION</code><td>Recap: Setting up Rust<tr><td><code>$NEXT_TITLE</code><td>Next exists<td>Text<td>Next article’s title<td><code>Next up: $NEXT_TITLE</code><td>Next up: Advanced Patterns<tr><td><code>$NEXT_PERMALINK</code><td>Next exists<td>Text<td>URL to next article<td><code>[Continue →]($NEXT_PERMALINK)</code><td><a href=/series/learn-rust/patterns>Continue →</a><tr><td><code>$NEXT_HTML_LINK</code><td>Next exists<td>HTML<td>Ready-to-use link to next<td><code>Continue with $NEXT_HTML_LINK</code><td>Continue with <a href=/series/learn-rust/patterns>Advanced Patterns</a><tr><td><code>$NEXT_DESCRIPTION</code><td>Next exists<td>Text<td>Description of next article<td><code>Coming up: $NEXT_DESCRIPTION</code><td>Coming up: Learn about Rust’s advanced pattern matching features</table></div><h3 id=first-article-reference><a aria-label="Anchor link for: first-article-reference" class="header-anchor no-hover-padding" href=#first-article-reference></a> First Article Reference</h3><div class=full-width><table><thead><tr><th>Variable<th>Availability<th>Returns<th>Description<th>Example Usage<th>Example Output<tbody><tr><td><code>$FIRST_TITLE</code><td>Always<td>Text<td>First article’s title<td><code>Start with $FIRST_TITLE</code><td>Start with Introduction to Rust<tr><td><code>$FIRST_HTML_LINK</code><td>Always<td>HTML<td>Ready-to-use link to first article<td><code>Begin at $FIRST_HTML_LINK</code><td>Begin at <a href=/series/learn-rust/intro>Introduction to Rust</a></table></div><h3 id=template-example><a aria-label="Anchor link for: template-example" class="header-anchor no-hover-padding" href=#template-example></a> Template Example</h3><div class="admonition tip"><div class="admonition-icon admonition-icon-tip"></div><div class=admonition-content>HTML vs text variablesUse HTML variables (ending in <code>_HTML_LINK</code>) when you want ready-made links. Use text variables (ending in <code>_TITLE</code> or <code>_PERMALINK</code>) when you want more control over the formatting.</div></div><pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md># Introduction. [extra.series_intro_templates] next_only = """ Welcome to $SERIES_HTML_LINK! This $SERIES_PAGES_NUMBER-part series will teach you Rust from scratch. Up next: $NEXT_HTML_LINK - $NEXT_DESCRIPTION """ middle = """ 📚 Part $SERIES_PAGE_INDEX of $SERIES_PAGES_NUMBER in $SERIES_HTML_LINK Previously: $PREV_HTML_LINK Next up: $NEXT_HTML_LINK """ prev_only = """ Welcome to the final part of $SERIES_HTML_LINK! New here? Start with $FIRST_HTML_LINK to build a strong foundation. Previously: $PREV_HTML_LINK """ # Fallback template. default = "This article is part of the $SERIES_HTML_LINK series." # Outro. [extra.series_outro_templates] next_only = """ Thanks for reading! 🙌 Continue your journey with $NEXT_HTML_LINK, where $NEXT_DESCRIPTION Or check out the complete [$SERIES_TITLE]($SERIES_PERMALINK) series outline. """ middle = """ --- 📝 Series Navigation - Previous: $PREV_HTML_LINK - Next: $NEXT_HTML_LINK - [Series Overview]($SERIES_PERMALINK) """ prev_only = """ 🎉 Congratulations! You've completed $SERIES_HTML_LINK. Want to review? Here's where we started: $FIRST_HTML_LINK Or check what we just covered in $PREV_HTML_LINK. """ # Fallback. default = """ --- This article is part $SERIES_PAGE_INDEX of $SERIES_PAGES_NUMBER in $SERIES_HTML_LINK. """ </code></pre><h3 id=custom-variables><a aria-label="Anchor link for: custom-variables" class="header-anchor no-hover-padding" href=#custom-variables></a> Custom Variables</h3>Series templates support custom variables for additional information you want to include across your series. The process takes two steps:<ol><li>First, define your placeholders in your series configuration (<code>_index.md</code>):</ol><pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md>[extra] series = true series_template_placeholders = ["$POSITION", "$TOPIC", "$DIFFICULTY"] </code></pre><ol start=2><li>Then, in each series article, provide the values for these placeholders in <code>series_template_variables</code>:</ol><pre class="language-toml z-code" data-lang=toml data-name=series/article.md><code class=language-toml data-lang=toml data-name=series/article.md>[extra.series_template_variables] position = "first" topic = "Variables and Types" difficulty = "Beginner" </code></pre><h3 id=using-custom-variables><a aria-label="Anchor link for: using-custom-variables" class="header-anchor no-hover-padding" href=#using-custom-variables></a> Using Custom Variables</h3>You can use your custom variables in any template, alongside the built-in variables:<pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md>[extra.series_intro_templates] default = """ This is the $POSITION article in $SERIES_HTML_LINK. Today's topic: $TOPIC Difficulty level: $DIFFICULTY """ </code></pre><div class="admonition warning"><div class="admonition-icon admonition-icon-warning"></div><div class=admonition-content>WARNINGWhile placeholders are defined with uppercase (<code>$POSITION</code>), the variable names in <code>series_template_variables</code> must be lowercase (<code>position</code>).</div></div><h3 id=example-with-custom-variables><a aria-label="Anchor link for: example-with-custom-variables" class="header-anchor no-hover-padding" href=#example-with-custom-variables></a> Example with Custom Variables</h3><pre class="language-toml z-code" data-lang=toml data-name=series/_index.md><code class=language-toml data-lang=toml data-name=series/_index.md># In the series configuration. [extra] series = true series_template_placeholders = ["$LEARNING_TIME", "$KEY_CONCEPTS"] series_intro_templates.default = """ 📚 Part $SERIES_PAGE_INDEX of $SERIES_PAGES_NUMBER ⏱️ Estimated time: $LEARNING_TIME 🔑 Key concepts: $KEY_CONCEPTS """ </code></pre><pre class="language-toml z-code" data-lang=toml data-name=series/02-learning-rust/index.md><code class=language-toml data-lang=toml data-name=series/02-learning-rust/index.md># In an article of the series. [extra.series_template_variables] learning_time = "30 minutes" key_concepts = "Functions, Error Handling, Pattern Matching" </code></pre>This will output:<pre class="language-txt z-code" data-lang=txt><code class=language-txt data-lang=txt>📚 Part 2 of 5 ⏱️ Estimated time: 30 minutes 🔑 Key concepts: Functions, Error Handling, Pattern Matching </code></pre><div class="admonition warning"><div class="admonition-icon admonition-icon-warning"></div><div class=admonition-content>Missing VariablesIf you use a placeholder in your templates but don’t provide its value in <code>series_template_variables</code>, the build will fail with an error listing the missing variables.</div></div></section><nav class="full-width article-navigation"><div></div><div><a aria-describedby=right_title aria-label=Prev href=https://welpo.github.io/tabi/blog/mastering-tabi-settings/>Prev →</a>Mastering tabi Settings: A Comprehensive Guide</div></nav></article></main><div id=button-container><div id=toc-floating-container><input class=toggle id=toc-toggle type=checkbox><label class=overlay for=toc-toggle></label><label title="Toggle Table of Contents" class=button for=toc-toggle id=toc-button><svg viewbox="0 -960 960 960" xmlns=http://www.w3.org/2000/svg><path d="M414.82-193.094q-18.044 0-30.497-12.32-12.453-12.319-12.453-30.036t12.453-30.086q12.453-12.37 30.497-12.37h392.767q17.237 0 29.927 12.487 12.69 12.486 12.69 30.203 0 17.716-12.69 29.919t-29.927 12.203H414.82Zm0-244.833q-18.044 0-30.497-12.487Q371.87-462.9 371.87-480.45t12.453-29.92q12.453-12.369 30.497-12.369h392.767q17.237 0 29.927 12.511 12.69 12.512 12.69 29.845 0 17.716-12.69 30.086-12.69 12.37-29.927 12.37H414.82Zm0-245.167q-18.044 0-30.497-12.32t-12.453-30.037q0-17.716 12.453-30.086 12.453-12.369 30.497-12.369h392.767q17.237 0 29.927 12.486 12.69 12.487 12.69 30.203 0 17.717-12.69 29.92-12.69 12.203-29.927 12.203H414.82ZM189.379-156.681q-32.652 0-55.878-22.829t-23.226-55.731q0-32.549 23.15-55.647 23.151-23.097 55.95-23.097 32.799 0 55.313 23.484 22.515 23.484 22.515 56.246 0 32.212-22.861 54.893-22.861 22.681-54.963 22.681Zm0-245.167q-32.652 0-55.878-23.134-23.226-23.135-23.226-55.623 0-32.487 23.467-55.517t56.12-23.03q32.102 0 54.721 23.288 22.62 23.288 22.62 55.775 0 32.488-22.861 55.364-22.861 22.877-54.963 22.877Zm-.82-244.833q-32.224 0-55.254-23.288-23.03-23.289-23.03-55.623 0-32.333 23.271-55.364 23.272-23.03 55.495-23.03 32.224 0 55.193 23.288 22.969 23.289 22.969 55.622 0 32.334-23.21 55.364-23.21 23.031-55.434 23.031Z"/></svg></label><div class=toc-content><div class=toc-container><ul><li><a href=https://welpo.github.io/tabi/blog/series/#quick-start>Quick Start</a><li><a href=https://welpo.github.io/tabi/blog/series/#how-do-series-work>How Do Series Work?</a><li><a href=https://welpo.github.io/tabi/blog/series/#jump-to-posts>Jump to Posts</a><li><a href=https://welpo.github.io/tabi/blog/series/#series-pages-and-order>Series Pages and Order</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#sorting-options>Sorting Options</a><li><a href=https://welpo.github.io/tabi/blog/series/#page-indexing>Page Indexing</a></ul><li><a href=https://welpo.github.io/tabi/blog/series/#intro-and-outro-templates>Intro and Outro Templates</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#template-types>Template Types</a><li><a href=https://welpo.github.io/tabi/blog/series/#placement-in-content>Placement in Content</a></ul><li><a href=https://welpo.github.io/tabi/blog/series/#variables>Variables</a> <ul><li><a href=https://welpo.github.io/tabi/blog/series/#basic-series-variables>Basic Series Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#navigation-variables>Navigation Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#first-article-reference>First Article Reference</a><li><a href=https://welpo.github.io/tabi/blog/series/#template-example>Template Example</a><li><a href=https://welpo.github.io/tabi/blog/series/#custom-variables>Custom Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#using-custom-variables>Using Custom Variables</a><li><a href=https://welpo.github.io/tabi/blog/series/#example-with-custom-variables>Example with Custom Variables</a></ul></ul></div></div></div><a title="Go to the top of the page" class=no-hover-padding href=# id=top-button> <svg viewbox="0 0 20 20" fill=currentColor><path d="M3.293 9.707a1 1 0 010-1.414l6-6a1 1 0 011.414 0l6 6a1 1 0 01-1.414 1.414L11 5.414V17a1 1 0 11-2 0V5.414L4.707 9.707a1 1 0 01-1.414 0z"/></svg> </a></div><script defer src=https://welpo.github.io/tabi/js/mermaid.min.js></script> Copied! Copy code to clipboard <script defer src=https://welpo.github.io/tabi/js/copyCodeToClipboard.min.js></script></div><footer><section><nav class="socials nav-navs"><ul><li><a class="nav-links no-hover-padding social" href=https://welpo.github.io/tabi/atom.xml> <img alt=feed loading=lazy src=https://welpo.github.io/tabi/social_icons/rss.svg title=feed> </a><li class=js><a class="nav-links no-hover-padding social" data-encoded-email=dGFiaUBvc2MuZ2FyZGVu href=#><img alt=email loading=lazy src=https://welpo.github.io/tabi/social_icons/email.svg title=email> </a><li><a class="nav-links no-hover-padding social" rel=" me" href=https://github.com/welpo/> <img alt=github loading=lazy src=https://welpo.github.io/tabi/social_icons/github.svg title=github> </a><li><a class="nav-links no-hover-padding social" rel=" me" href=https://soundcloud.com/oskerwyld> <img alt=soundcloud loading=lazy src=https://welpo.github.io/tabi/social_icons/soundcloud.svg title=soundcloud> </a><li><a class="nav-links no-hover-padding social" rel=" me" href=https://instagram.com/oskerwyld> <img alt=instagram loading=lazy src=https://welpo.github.io/tabi/social_icons/instagram.svg title=instagram> </a><li><a class="nav-links no-hover-padding social" rel=" me" href=https://youtube.com/@oskerwyld> <img alt=youtube loading=lazy src=https://welpo.github.io/tabi/social_icons/youtube.svg title=youtube> </a><li><a class="nav-links no-hover-padding social" rel=" me" href=https://open.spotify.com/artist/5Hv2bYBhMp1lUHFri06xkE> <img alt=spotify loading=lazy src=https://welpo.github.io/tabi/social_icons/spotify.svg title=spotify> </a></ul></nav><nav class=nav-navs> <ul><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/about/> about </a><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/privacy/> privacy policy </a><li><a class="nav-links no-hover-padding" href=https://tabi-stats.osc.garden/> site statistics </a><li><a class="nav-links no-hover-padding" href=https://welpo.github.io/tabi/sitemap.xml> sitemap </a></ul> </nav><div class=credits> Powered by <a href=https://www.getzola.org>Zola</a> & <a href=https://github.com/welpo/tabi>tabi</a> • <a href=https://github.com/welpo/tabi> Site source </a></div></section><script async src=https://welpo.github.io/tabi/js/decodeMail.min.js></script><div class="search-modal js" aria-labelledby=modalTitle id=searchModal role=dialog><h1 class=visually-hidden id=modalTitle>Search</h1><div id=modal-content><div id=searchBar><div aria-hidden=true class=search-icon><svg viewbox="0 -960 960 960" xmlns=http://www.w3.org/2000/svg><path d="M784-120 532-372q-30 24-69 38t-83 14q-109 0-184.5-75.5T120-580q0-109 75.5-184.5T380-840q109 0 184.5 75.5T640-580q0 44-14 83t-38 69l252 252-56 56ZM380-400q75 0 127.5-52.5T560-580q0-75-52.5-127.5T380-760q-75 0-127.5 52.5T200-580q0 75 52.5 127.5T380-400Z"/></svg></div><input aria-controls=results-container aria-expanded=false autocomplete=off id=searchInput placeholder=Search… role=combobox spellcheck=false><div class="close-icon interactive-icon" title="Clear search" id=clear-search role=button tabindex=0><svg viewbox="0 -960 960 960" xmlns=http://www.w3.org/2000/svg><path d="m256-200-56-56 224-224-224-224 56-56 224 224 224-224 56 56-224 224 224 224-56 56-224-224-224 224Z"/></svg></div></div><div id=results-container><div id=results-info> No results $NUMBER result $NUMBER results $NUMBER results $NUMBER results</div><div id=results role=listbox></div></div></div></div></footer>