State

States define what type of status a document may have. There is a page for each state so visitors may hop from a state type to documents with that status.

To view the available states, hover over 🧭 and click on the β€˜home’ tag emoji – it is currently πŸ”–. State pages can also be navigated to by clicking on a state (almost) whenever you see one around the site.

Markdown 🐝

States require emoji and emojipedia frontmatter attributes to be filled out.

---
id: <unique-id>
title: <your-title
emoji: <an-emoji>
emojipedia: 'https://emojipedia.org/<emoji>/'
---

<your-description-here>

Config 🐝

When the states display on the jekyll site, it’s important to define one state that is the β€˜root’ state. This will be the page the home tag button navigates to and lists a summary of all states on the site. It can be configured like so:

collections:
  states:
    output: true
    order:
      - tags.md
      - sprout.md
      - bud.md
      - bamboo.md
      - bloom.md
      - berry.md
      - fruit.md
      - melon.md
      - seed.md
      - tea.md
      - pot-bamboo.md
bonsai:
  states:
    root_path: "_states/tags.md"

order: This jekyll convention determines the order the states are displayed in the navbar at the top of state pages.

root_path: Defines which stage should be displayed when a visitor navigates to the states pages. That page will display descriptions for all valid states for the site.