Guidelines #

Every page should have Front Matter #

Front Matter is metadata at the top of every file, inside a block that starts and ends with three dashes.

---
Title: PAGE TITLE
---

Front matter can be in (at the time of writing) yaml, toml, and json. We currently define it in yaml format.

Required attributes #

The Title attribute is required on every markdown file, and in the case of directory _index.md file, the bookCollapseSection attribute should be set to true.

Optional attributes #

if you have moved the markdown file from another location, add the alias attribute for redirects to keep the old url working.

Formats #

• Content must be in markdown
• webp images are encouraged, but not currently required
• Code blocks should have a language for syntax highlighting