Overview
Introduction
Content authoring allows you to write, organize, and format your documentation using standard Markdown, MDX (Markdown with JSX capabilities), and frontmatter metadata. By combining these formats, you can create rich, interactive documentation pages complete with headings, tables, code blocks, diagrams, and custom layout options.
Frontmatter Configuration
Overview of Frontmatter
Frontmatter sits at the very top of your Markdown or MDX files enclosed by triple dashed lines (---). It defines page-level metadata such as titles, descriptions, icons, and layout settings.
---
title: Getting Started
description: Learn how to set up your project.
icon: rocket
full: false
---Supported Frontmatter Options
| Option | Type | Description |
|---|---|---|
title | string | The title of the page. If omitted, the system automatically uses the first level-1 heading (#). |
description | string | A short summary of the page content, used for tooltips, previews, and search indexes. |
icon | string | An icon identifier associated with the page navigation item. |
full | boolean | When set to true, extends the page container to fill all available width. |
Tip
If you omit the title frontmatter property, the system will automatically scan your document and use the first level-1 heading (#) as your page title.
Writing and Formatting Content
Content Formatting Basics
You can structure your documentation using standard formatting syntax alongside special component enhancements.
Headings and Sections
Use standard Markdown headings (# through ######) to structure your document. Headings automatically generate table-of-contents entries and unique identifiers for deep linking.
Note
Always ensure your headings are properly nested. Skipping heading levels can disrupt the automatically generated table of contents.
Embedding Code Blocks and External Files
You can embed standard code blocks with syntax highlighting, or include external files and specific code regions using the include feature. When embedding external files, the system supports VS Code–style region markers (such as // #region region-name and // #endregion) to pull in only the relevant lines of code.
Warning
When using file inclusion tags, ensure the target file path is relative to the current file or project root, otherwise the build process will throw an error.