demo-docs

Guide

Content Authoring

Writing documentation in Markdown

All documentation is written in Markdown, a lightweight markup language that's easy to learn and use.

Each page in your documentation is a Markdown file with optional frontmatter for configuration.

Basic syntax

Markdown supports all the formatting you need:

Frontmatter

At the top of each file, you can include YAML frontmatter to configure the page:

Best practices

Write clear, concise documentation that helps users accomplish their goals. Use headings to organize content and code examples to illustrate concepts.

Next, learn about Components to customize your pages.