Presidium Open Source

Front matter


Overview

Front Matter serves two purposes:

  • Indicates that the file should be included as an article in the build process
  • Allows you to set properties for your article

For example:

---
title: Presidium
slug: overview
url: front-matter/overview
weight: 1
authors: github-username
roles: Developer
status: Draft
---

Presidium includes the following front matter variables:

VariableDescription
titleA string representing the article or subsection title or the title of the subsection.
slugA string representing the slug for deep linking the article
urlA string representing the URL for the article
weightA number to provide ordering of articles, a higher number means the article will appear later in the section
authorA string, generally the Github username of the main author of the article.
githubA string, representing the Github username of the main author of the article.
rolesA list of strings representing the appropriate roles for an article.
statusA string that indicates the status of the article (draft, complete, in progress, etc.)