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.

Markdown .md pages are plain text documents with a simple, human-readable syntax designed to make writing for the internet easier. No special software is required — any basic text editor will do. Save the file with a .md extension and Retype handles the rest.

​
Quick start

A minimal page requires only a title and some content: 
# Page title here

This is a paragraph.
Build on that foundation with formatting, images, and lists: 
# Getting Started

Welcome to **my project**. This guide covers the _basics_.

## Prerequisites

- Node.js 18 or later
- A text editor

## Installation

1. Clone the repository
2. Run `npm install`
3. Run `retype start`

![Screenshot of the dashboard](/images/dashboard.png)
1

Create a Markdown file

Create a readme.md file in your project root.
2

Add a title

Add a # Title as the first heading in the file.
3

Start writing

Add your content below the title using standard Markdown.
4

Run Retype

Run retype start to preview your site locally.

​
Home page

Your project should include a default file in the root directory. Retype recognises any of the following filenames as the home page:
  • readme.md
  • index.md
  • default.md
  • welcome.md
  • home.md
The same convention applies inside subdirectories. Given this structure: 
|-- guides
    |-- index.md
    |-- getting-started.md
|-- readme.md
Retype generates three pages at the following URLs:
  1. /
  2. /guides/
  3. /guides/getting-started/
If your site shows the default Retype Welcome page, you need to add a home page file (readme.md, index.md, etc.) to the root of your project.

​
Standard Markdown syntax

​
Headings

Use # characters to create headings. Retype supports six levels. 
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

​
Text formatting

**Bold text**
_Italic text_
~~Strikethrough~~
`Inline code`

​
Lists

- Item one
- Item two
  - Nested item
- Item three

[Link text](https://example.com)
![Alt text for image](/images/screenshot.png)

​
Blockquotes

> This is a blockquote.
> It can span multiple lines.

​
Tables

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

​
Code blocks

Fence code blocks with triple backticks and include a language tag for syntax highlighting: 
```javascript
const greeting = 'Hello, world!';
console.log(greeting);
```

​
Retype extensions

Retype supports [[PageName]] wiki-style reference links. These automatically link to matching pages in your project: 
See the [[Getting Started]] guide for setup instructions.
Retype resolves the link by searching for a page whose title or filename matches.

​
Definition lists

Create definition lists with a term followed by a colon-prefixed definition: 
Term
: Definition of the term.

Another term
: Another definition.

​
Custom attributes

Add CSS classes or other HTML attributes to elements using the { } syntax: 
## Section heading {.custom-class}

![Logo](/images/logo.png){.rounded}

​
Callouts

Retype uses !!! fences for callout blocks: 
!!!
This is an informational callout.
!!!

!!!tip
This is a tip callout.
!!!

!!!warning
This is a warning callout.
!!!

​
Tabs

+++ Tab 1
Content for tab one.
+++ Tab 2
Content for tab two.
+++

​
Components

In addition to Markdown syntax, Retype includes a full library of components for enriching your documentation — including badges, cards, panels, code groups, and more. See the Retype component reference for the complete list.

Build docs developers (and LLMs) love

Get started for freeTalk to us