Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process.

Add a tag to a page

You can add tags to pages by adding tags in the frontmatter with values inside brackets, like this:

---
title: 5.0 Release Notes
permalink: release_notes_5_0.html
tags: [formatting, single_sourcing]
---

or inside an unordered list, like this:

---
title: 5.0 Release Notes
permalink: release_notes_5_0.html
tags: 
  - formatting
  - single_sourcing
---

Tags overview

To prevent tags from getting out of control and inconsistent, first make sure the tag appears in the _data/tags.yml file. If it’s not there, the tag you add to a page won’t be read. I added this check just to make sure I’m using the same tags consistently and not adding new tags that don’t have tag archive pages.

Additionally, you must create a tag archive page similar to the other pages named tag_{tagname}.html folder. This theme doesn’t auto-create tag archive pages.

For simplicity, make all your tags single words (connect them with hyphens if necessary).

Setting up tags

Tags have a few components.

  1. In the _data/tags.yml file, add the tag names you want to allow. For example:

    allowed-tags:
  - getting_started
  - overview
  - formatting
  - publishing
  - single_sourcing
  - special_layouts
  - content types

  2. Create a tag archive file for each tag in your tags_doc.yml list. Name the file following the same pattern in the tags folder, like this: tag_collaboration.html.

    Each tag archive file needs only this:

    ---
title: "Collaboration pages"
tagName: collaboration
search: exclude
permalink: tag_collaboration.html
sidebar: mydoc_sidebar
---
{% include taglogic.html %}

  3. Change the title, tagName, and permalink values to be specific to the tag name you just created.

    By default, the _layouts/page.html file will look for any tags on a page and insert them at the bottom of the page using this code:

<div class="tags">
{% if page.tags != null %}
<b>Tags: </b>
{% assign projectTags = site.data.tags.allowed-tags %}
{% for tag in page.tags %}
{% if projectTags contains tag %}
<a href="{{ "tag_" | append: tag | append: ".html" }}" class="btn btn-default navbar-btn cursorNorm" role="button">{{page.tagName}}{{tag}}</a>
{% endif %}
{% endfor %}
{% endif %}
</div>

Because this code appears on the _layouts/page.html file by default, you don’t need to do anything in your page to get the tags to appear. However, if you want to alter the placement or change the button color, you can do so within the _includes/taglogic.html file.

You can change the button color by changing the class on the button from btn-info to one of the other button classes bootstrap provides. See Labels for more options on button class names.

Retrieving pages for a specific tag

If you want to retrieve pages outside of a particular tag_archive page, you could use this code:

Getting started pages:
<ul>
{% for page in site.pages %}
{% for tag in page.tags %}
{% if tag == "getting_started" %}
<li><a href="{{page.url | remove: "/" }}">{{page.title}}</a></li>
{% endif %}
{% endfor %}
{% endfor %}
</ul>

Here’s how that code renders:

Getting started pages:

If you want to sort the pages alphabetically, you have to apply a sort filter:


Getting started pages:
<ul>
{% assign sorted_pages = site.pages | sort: 'title' %}
{% for page in sorted_pages %}
{% for tag in page.tags %}
{% if tag == "getting_started" %}
<li><a href="{{page.url | remove: "/" }}">{{page.title}}</a></li>
{% endif %}
{% endfor %}
{% endfor %}
</ul>

Here’s how that code renders:

Getting started pages:

Efficiency

Although the tag approach here uses for loops, these are somewhat inefficient on a large site. Most of my tech doc projects don’t have hundreds of pages (like my blog does). If your project does have hundreds of pages, this for loop approach with tags is going to slow down your build times.

Without the ability to access pages inside a universal namespace with the page type, there aren’t many workarounds here for faster looping.

With posts (instead of pages), since you can access just the posts inside posts.tag.tagname, you can be a lot more efficient with the looping.

Still, if the build times are getting long (e.g., 1 or 2 minutes per build), look into reducing the number of for loops on your site.

Empty tags?

If your page shows “tags:” at the bottom without any value, it could mean a couple of things:

  • You’re using a tag that isn’t specified in your allowed tags list in your tags.yml file.
  • You have an empty tags: [] property in your frontmatter.

If you don’t want tags to appear at all on your page, remove the tags property from your frontmatter.

Remembering the right tags

Since you may have many tags and find it difficult to remember what tags are allowed, I recommend creating a template that prepopulates all your frontmatter with all possible tags. Then just remove the tags that don’t apply.

See WebStorm Text Editor for tips on creating file templates in WebStorm.

Tags: navigation