Source file conventions
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:
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.
|title||yes||The page title. This is added to the HTML output as a |
|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.|
|redirect_from||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.|
|toc_min||no||Ignored if |
|toc_max||no||Ignored if |
|skip_read_time||no||Set to |
|skip_feedback||no||Set to |
|sitemap||no||Exclude the page from indexing by search engines. When set to |
Here's an example of a valid (but contrived) page metadata. The order of the metadata elements in the front matter isn't important.
--- description: Instructions for installing Docker Engine on Ubuntu keywords: requirements, apt, installation, ubuntu, install, uninstall, upgrade, update title: Install Docker Engine on Ubuntu redirect_from: - /ee/docker-ee/ubuntu/ - /engine/installation/linux/docker-ce/ubuntu/ - /engine/installation/linux/docker-ee/ubuntu/ - /engine/installation/linux/ubuntu/ - /engine/installation/linux/ubuntulinux/ - /engine/installation/ubuntulinux/ - /install/linux/docker-ce/ubuntu/ - /install/linux/docker-ee/ubuntu/ - /install/linux/ubuntu/ - /installation/ubuntulinux/ toc_max: 4 ---
The body of the page (with the exception of keywords) starts after the front matter
Splitting long lines (preferably up to 80 characters) can make it easier to provide feedback on small chunks of text.