Source File Naming and Front Matter Conventions

1st chunk of `content/contribute/file-conventions.md`

0278b519d0c21d536e8029b1a06c0a5395ad673f4e1412de0000000100000a51

---
title: Source file conventions
description: How new .md files should be formatted
keywords: source file, contribute, style guide
weight: 30
---

## File name

When you create a new .md file for new content, make sure: 
- File names are as short as possible
- Try to keep the file name to one word or two words
- Use a dash to separate words. For example:
  - `add-seats.md`  and `remove-seats.md`.
  - `multiplatform-images` preferred to `multi-platform-images`.

## Front matter

The front matter of a given page is in a section at the top of the Markdown
file that starts and ends with three hyphens. It includes YAML content. The
following keys are supported. The title, description, and keywords are required.

| Key             | Required | Description                                                                                                                                                                                                    |
|-----------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| title           | yes      | The page title. This is added to the HTML output as a `<h1>` level header.                                                                                                                                     |
| description     | yes      | A sentence that describes the page contents. This is added to the HTML metadata. It’s not rendered on the page.                                                                                                |
| keywords        | yes      | A comma-separated list of keywords. These are added to the HTML metadata.                                                                                                                                      |
| aliases         | no       | A YAML list of pages which should redirect to the current page. At build time, each page listed here is created as an HTML stub containing a 302 redirect to this page.                                        |
| notoc           | no       | Either `true` or `false`. If `true`, no in-page TOC is generated for the HTML output of this page. Defaults to `false`. Appropriate for some landing pages that have no in-page headings.                      |
| toc_min         | no       | Ignored if `notoc` is set to `true`. The minimum heading level included in the in-page TOC. Defaults to `2`, to show `<h2>` headings as the minimum.                                                           |

Title: Source File Naming and Front Matter Conventions

Summary

This section outlines the conventions for naming .md files and structuring the front matter (YAML content) at the beginning of each file. It specifies that file names should be short, use dashes to separate words, and the front matter must include a title, description, and keywords. It also describes optional front matter configurations, like setting up aliases, disabling the table of contents (TOC), and setting the minimum heading level for the TOC.