Headings and Text

Overview

You can format content in two ways:

• Editor UI – Use the slash / menu, toolbar, and link dialog.

• MDX/Markdown – Type formatting syntax directly in the editor.

The page title renders as H1, so body headings typically begin at ##.

Headings

Using the editor UI

1. Place your cursor on a new line.

2. Type / to open the block menu.

3. Choose Heading 1, Heading 2, or Heading 3 for the desired level.

4. Type your heading text.

You can switch an existing block between paragraph and heading levels using the left-hand block dropdown (for example, changing Paragraph → Heading 2).

Using MDX syntax

Use # symbols to create headings:

## Section
### Subsection
#### Detail (use H4 as deepest level)

Paragraphs

Using the editor UI

• Start typing in a Paragraph block (the default block type).

• Press Enter to create a new paragraph.

• Use the block dropdown to switch a heading back to "Paragraph" if needed.

Using MDX syntax

Separate paragraphs with a blank line:

This is a paragraph with one idea.

This is another paragraph that advances the topic.

This is a paragraph with one idea.

This is another paragraph that advances the topic.

Inline emphasis and formatting

Using the editor UI

Using MDX syntax

Style effects

• Bold - Renders text in strong weight for emphasis

• Italic - Renders text in slanted style for subtle emphasis

• Strikethrough - Renders text with line through for deletions/deprecation

• Inline code - Renders text in monospace font with background highlight

• Keyboard - Renders text as keyboard keys for shortcuts and commands

Links

Using the editor UI

1. Select the text you want to turn into a link.

2. Click the link icon in the floating toolbar.

3. In the link input:

   • Link to an internal page

     • Type / to search existing documentation pages.

     • Choose the page you want to link.

   • Link to an external page

     • Paste the full URL (for example, https://documentation.ai) and press Enter.

You can edit or remove the link later by placing your cursor in the linked text and reopening the link input.

Using MDX syntax

Internal links:

Use absolute paths from the docs root:

[Quickstart](/getting-started/quickstart)
[Components](/components)

Quickstart Components

External links:

Use absolute URLs:

[Documentation.AI](https://documentation.ai/)

Documentation.AI

Line breaks and spacing

Using the editor UI

• New paragraph: Press Enter once.

• New paragraph with extra spacing: Avoid pressing Enter multiple times; use headings and paragraphs for structure instead of stacked blank lines.

Using MDX syntax

Paragraph breaks

Leave a blank line between paragraphs:

First paragraph.

Second paragraph.

First paragraph.

Second paragraph.

Manual line breaks

Insert <br /> for controlled breaks within a paragraph:

First line with an intentional break.<br />
Second line continues the same paragraph.

First line with an intentional break.
The second line continues the same paragraph.