Skip to content

Documents

experimenthouse edited this page Mar 6, 2019 · 2 revisions

Documents are special pages that are specially formatted for official purposes. The general features of documents are a minimalistic design focused on readability and suitability for printing and legislation-style numbering of clauses.

Documents are appropriate for:

  • structural documents like terms of reference for committees and individual roles; and
  • internal policies and procedures.

They can, of course, be used for similar official documents.

Making a document

Documents are made by creating a Markdown file in a collection directory:

  • website/_collection/document-title.markdown

Collections are exactly that --- directories that group content together. Currently there are two collections for documents:

  • website/_terms-of-reference
  • website/_policies

The document file should be placed in whichever collection directory is most appropriate.

Document frontmatter

Every document requires frontmatter at the start of the file to determine its layout and title. This is in YAML format and will typically look like this:

---
layout: document
title: "Document Title"
---

Document content

Document content begins after the YAML frontmatter and is written using Markdown syntax:

---
layout: document
title: "Document Title"
---

## Section Heading

1. Subsection (1)
  1. Paragraph (a)
    1. Subparagraph (i)
    2. Subparagraph (ii)
  2. Paragraph (b)
2. Subsection (2)

Clone this wiki locally