Markdoc Format

Markdoc format is the format used when pages are synced on DeveloperHub using GitHub Sync. Markdoc is markdown-based authoring framework for writing documentation.

If you author pages with an AI coding agent, our Markdoc Agent Skill teaches it this exact syntax, so its edits round-trip cleanly. To see a page the way readers will while you write it, use the editor preview.

Frontmatter Syntax

Every page has a frontmatter header, such as this one:

Markdoc Syntax

Markdoc is a superset of Markdown, so you can still write Markdown as you usually do, including the following nodes:

In addition to Markdown, we provide tags and attributes for all blocks and inline blocks.

Blocks have the following syntax:

While inline blocks have the following syntax:

The syntax is shown below for every block with an example:

Code Block

A Code block is a single fenced block with the language on the opening fence. Code tabs wrap several fenced blocks in a {% code %} / {% /code %} pair.

Images

Self-closing when there is no caption, or a body form when there is:

Tables

Tables are {% row %} and {% cell %} trees; a header cell sets header=true. Add stickyHeader=true to pin the header row while the table scrolls, and searchable=true to a header cell to let readers search that column. A simple table can also be written as a plain Markdown pipe table.

Callouts

Videos

Synced Blocks

If the block has variables, a page can set its own values for them with variables, each in quotes. Any variable left out shows the block's default:

The block's own file declares the variables and uses them, as shown in Synced Blocks.

Custom HTML

Tabs

Changelog

GitHub Code

Index List