On this page
You can customize individual pages in Doks by setting values in their frontmatter. Frontmatter is set at the top of your files between
Every page must include at least a
title. See the frontmatter reference for all available fields and how to add custom fields.
Text can be bold, italic, or
You can link to another page.
You can highlight
inline code with backticks.
Hyas Images supports the Markdown syntax for displaying images that includes alt-text for screen readers and assistive technology.
You can structure content using a heading. Headings in Markdown are indicated by a number of
# at the start of the line.
How to structure page content in Doks
Doks is configured to automatically use your page title as a top-level heading. We recommend starting each page with regular paragraph text content and using on-page headings from
<h2> and down:
Automatic heading anchor links
Using headings in Markdown will automatically give you anchor links so you can link directly to certain sections of your page:
Level 2 (
<h2>) and Level 3 (
<h3>) headings will automatically appear in the page table of contents — the “On this page” section.
This is a blockquote, which is commonly used when quoting another person or document.
Blockquotes are indicated by a
>at the start of each line.
A code block is indicated by a block with three backticks
``` at the start and end. You can indicate the programming language being used after the opening backticks.
Extended code formatting
Need extended code formatting? See our Code blocks guides.