Template

Barebones template for documentation pages. Copy and paste to your heart’s content.

Documentation template.

This page serves as a template you can copy and paste when you want to create a new documentation page. It contains the basic structure and formatting you need to get started.

It is expected that such pages are written in markdown and that they are placed in the documentation/src/content/docs directory within an appropriate folder. Feel free to make subfolders if you wish.

Frontmatter

At the top of each markdown file, you will find a section enclosed in --- which is called “frontmatter”. This is where you can specify metadata about the page, such as the title and description. For example:

---
title: My Documentation Page
description: A brief description of what this page is about.
---

It is very important that you include the title and description at a bare minimum, as it helps with search and title displaying.

Markdown

As mentioned before, markdown is the chosen (and very popular!) format for writing documentation. Feel free to use a website like Dillinger to write and preview your markdown if you have trouble.

Basic guide

Markdown Syntax	Description
# Heading 1	Creates a level 1 heading.
## Heading 2	Creates a level 2 heading. (Should be used for main sections like the “Markdown” heading)
### Heading 3	Creates a level 3 heading.
**bold**	Makes text bold.
*italic*	Makes text italic.
- List item	Creates a bullet point in a list.
[Link text](https://example.com)	Creates a hyperlink to another page here or external website.
	Embeds an image from a URL.
`Inline code`	Formats text as inline code.

Code blocks such as the one above can be created using triple backticks (```) before and after the code. You can also specify the language for syntax highlighting, like markdown in the example above.