Front Matter Overview

Contents

• Introduction
• Prerequisites
• Example
• Elements Explained
  • Layout (Required)
  • Title (Required)
  • Breadcrumb (Required)
  • Author (Required)
  • Status (Optional)
  • Category (Not Used)
  • ContentType (Not Used)
  • Tags (Required)
• For Further Reading

Introduction

Jekyll breaks a page up into a few sections, including Front Matter and Content.

At the beginning of each Markdown (md) file, Jekyll looks for the presence of Front Matter. The term "Front Matter" comes from the idea of all the material that comes at the "front" of a publication. For any md file to be processed, it must have Front Matter. Think of Front Matter as metadata describing the page and contents.

This section will go through each data element that Front Matter should contain for every page in the Squirrel U site. Front Matter can be different for every project/site, but we are focusing on what has been chosen for Squirrel U content.

Prerequisites

• None

Example

Here is an example of Front Matter for Squirrel U content. This "block" should be included at the top of every index.md file in the Squirrel U directory structure.

1
2
3
4
5
6
7
8
9
10