Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/retypeapp/retype/llms.txt

Use this file to discover all available pages before exploring further.

Retype extends standard Markdown with a rich set of built-in components called Retype Flavored Markdown (RFM). These components let you create callouts, code groups, diagrams, media embeds, and interactive elements without writing any HTML. All RFM components use a consistent syntax based on familiar Markdown patterns — fenced blocks, link-style notation, and attribute lists — so they integrate naturally into your writing flow.

Component catalog

Text and labels

Callouts

Highlight important messages with styled alert boxes. Supports named variants (info, warning, danger, tip, and more), collapsible state, and GitHub Alert syntax.

Badge

Inline labels for status, version, or category. Supports variants, sizes, corner styles, icons, and optional links.

Layout

Columns

Arrange content side by side in equal-width columns using the ||| fence syntax.

Panels

Collapsible accordion sections using the === fence syntax. Stack multiple panels and mix expanded and collapsed states.

Tabs

Group content into a tabbed interface using the +++ fence syntax. Each tab is a deep-linkable anchor.

Card

Linked preview cards that pull title, description, and image from page metadata. Supports horizontal, vertical, and compact layouts.

Container

Wrap any content in a <div> with a custom CSS class using the ::: syntax.

Code

Code blocks

Fenced code blocks with syntax highlighting, line numbers, line highlighting, titles, and code groups.

Code snippets

Include content from external source files directly into a code block, with optional range, region, title, and language.

Mermaid diagrams

Render flowcharts, sequence diagrams, Gantt charts, ER diagrams, and more using the Mermaid diagramming language.

Math formulas

Render LaTeX math expressions inline or as display blocks using KaTeX.

Media

Images

Standard Markdown images with Retype extensions for sizing, alignment (left, right, center, plus variants), and custom HTML attributes.

YouTube

Auto-embed YouTube videos by pasting a URL on its own line. Supports all YouTube player parameters.

Embed

General-purpose iframe embed component with controls for aspect ratio, dimensions, and the wrapping HTML element.

Interactive

Buttons

Styled call-to-action links using [!button] syntax. Supports variants, sizes, corner styles, icons, and link targets.

Steps

Numbered step sequences using the >>> fence syntax. Steps are deep-linkable anchors and support rich inner content.

Reference links

Prominent linked navigation blocks using [!ref] syntax. Automatically resolves the page title as link text.

Backlinks

Display a list of pages that link to the current page. Supports manual placement and custom titles. Requires Retype Pro.
All RFM components work within standard Markdown files (.md) and MDX files (.mdx). No plugins or configuration are required to enable them — they are built into Retype.

Build docs developers (and LLMs) love