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 turns your Markdown .md files into a beautiful, fully-functional documentation website. Write in plain Markdown, run one command, and you have a production-ready site you can host anywhere.

Installation

Install Retype in seconds using npm, yarn, or dotnet

Quick Start

Get your first Retype site running in minutes

CLI Reference

All commands, flags, and options for the Retype CLI

Configuration

Customize your site with the retype.yml project file

Components

Enrich your content with tabs, callouts, cards, and more

Hosting

Deploy your site to GitHub Pages, Netlify, Cloudflare, and more

Why Retype?

Retype is designed to get out of your way so you can focus on writing. There’s no complex build pipeline, no framework to learn, and no dependencies to maintain.
  • Zero coding required — write Markdown, run retype start, done
  • Lightning fast — incremental builds using a page dependency graph mean near-instant rebuilds
  • Live reload — edits appear in your browser automatically as you save
  • Host anywhere — outputs plain HTML/CSS/JS that works on any web server or CDN
  • Rich components — tabs, callouts, code blocks, cards, math formulas, and more
  • Built-in search — full-text search works out of the box with no external services

How it works

1

Install Retype

Install the retypeapp package using npm, yarn, or dotnet — whichever you already have.
npm install retypeapp --global
2

Start your project

Navigate to any folder with Markdown files and run retype start.
retype start
Retype builds your site and opens it in the browser automatically.
3

Write your content

Edit your .md files. Retype watches for changes and refreshes the browser instantly.
4

Deploy

Run retype build to generate a static site, then upload the output to any host.
retype build

Supported package managers

Retype can be installed with any of the following:
Package ManagerInstall command
npmnpm install retypeapp --global
yarnyarn global add retypeapp
dotnetdotnet tool install retypeapp --global
All three package managers produce the same result. If you already have dotnet installed, it’s typically the fastest option.

Build docs developers (and LLMs) love