Adding post tags - mdsimpson42/converse GitHub Wiki

The site includes a number of tags which can be added to blog posts. These tags are used to help categorise and explore the posts on this site. The tags are currently mainly used to describe the mental health topic that the post is about, for example: Anxiety, Depression, Burnout.

Clicking on a tag will take you to a page which contains a list of all blog posts that include that tag. Ideally, that page should also include additional information about the topic, and links to additional sources of information (as in the examples above).

Adding a new post tag

To add a tag, add a markdown file into the _tags directory in the root of the codebase. Most tags are currently one-word or in snake_case.

The markdown file should include the following header material:

---
short_name: impostor_syndrome
title: Impostor Syndrome
menu: blog
---

The short_name is the name that will be added to the tags field on any blog post. As with the filename, this should be one word or snake_case. The title field is how the tag will be displayed whenever it appears on the site. This can be better formatted with spaces, as shown above. (Ignore the menu field, which is used by the site's navigation code.)

Under the header content, the rest of the markdown file is the content that will be displayed at the top of the page when someone clicks on a tag. The plan was to include some basic information about the topic and links to additional information, as shown in the examples above.

Adding a tag to a blog post

Once the markdown file has been added, you should be able to add a tag to a post by adding the short_name of the tag to the tags parameter in the header of the post file.

Tags should be added in an array, i.e. tags: [anxiety, depression, burnout].