Logo
Docs

Format Text

Write most pages in plain Markdown first. Because Radiant Docs uses MDX, you can keep standard Markdown syntax for text and only reach for components when you need richer UI.

Subtitle

Bold, italics, underline, strokethrough, inline code.

Create a link to another docs page or an external link.

This is a blockquote.

## Subtitle **Bold**, _italics_, <u>underline</u>, ~~strokethrough~~, `inline code`. Create a [link to another docs page](/creating-content/format-text) or an [external link](https://mdxjs.com). > This is a blockquote.

Headers

Page titles

Set the main page title in frontmatter when you want full control over the page heading.

---title: Format text with Markdown and MDX---

Radiant Docs resolves the rendered page title in this order:

  1. title in the page frontmatter
  2. title on the page entry in docs.json
  3. A title derived from the MDX file name: format-text.mdx -> Format Text.

Section headings and subheadings

For headings inside the page body, start with ##. Use ### for subsections.

Section heading

Use short paragraphs under each heading.

Subsection heading

Add a subsection when the section needs one more level.

## Section heading Use short paragraphs under each heading. ### Subsection heading Add a subsection when the section needs one more level.

Emphasis

Use emphasis to help readers scan, not to decorate every sentence.

Use bold for strong emphasis.

Use italics for light emphasis.

Use underlined text when you need underline.

Use strikethrough for removed or outdated text.

Use inline code for commands, file names, and identifiers.

Use **bold** for strong emphasis. Use *italics* for light emphasis. Use <u>underlined text</u> when you need underline. Use ~strikethrough~ for removed or outdated text. Use `inline code` for commands, file names, and identifiers.

Combine emphasis styles

You can combine emphasis styles too.

Bold italics

underlined italics

underlined bold

strikethrough bold

***Bold italics*** *<u>underlined italics</u>* **<u>underlined bold</u>** **~~strikethrough bold~~**

Use standard Markdown links for both internal and external destinations.

Use internal links for pages within your docs site.

Format Text

[Format Text](/creating-content/format-text)

Use external links for resources outside your docs site.

MDX documentation

[MDX documentation](https://mdxjs.com)

Prefer descriptive link text. Avoid vague phrases like click here or read more.

Blockquotes

Use blockquotes for quoted text or a short aside that should stand apart from the main paragraph flow.

Preview your page locally before you commit it.

> Preview your page locally before you commit it.

Keep blockquotes short. If the content is an instruction or warning, a component such as <Callout /> is usually clearer.

Show JSX or HTML as text

MDX treats angle brackets as JSX, so literal HTML or component names need escaping.

You can write <Component title="Example"> with backticks (``) to display as inline code or write <Component title="Example" /> with {curly brackets} + "quotation marks" to display as regular text.

You  can write `<Component  title="Example">` with backticks (``) to displayas inline code or write **{'<Component title="Example" />'}** with{'{'}curly brackets{'}'} + "quotation marks" to display as regular text.

Use this whenever you are writing about a component or html instead of rendering it.