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.

​
What is Retype?

Retype is a static website generator that transforms Markdown .md files into a complete documentation website — no coding required. Write in Markdown, and Retype handles the rest. Retype is well-suited for:
  • Project documentation
  • Knowledge bases
  • API docs
  • Team wikis
  • Personal blogs or notes
  • Self-published content
The retype.com website itself is generated using Retype.

​
Get started

1

Install Retype

Install Retype globally using npm, yarn, or the dotnet CLI. Only one package manager is required.
npm install retypeapp --global
For full prerequisites and platform-specific options, see the Installation page.Verify the install succeeded:
retype --version
2

Start the development server

Navigate to any folder that contains Markdown files and run:
retype start
If you do not have any Markdown files yet, create a readme.md file to get started:
# Hello, Retype

Welcome to my new documentation site.
Retype will automatically:
  1. Find your Markdown files
  2. Build your website
  3. Open it in your browser
  4. Watch for changes and live-reload the browser
The development server runs locally and is not accessible publicly. It is intended for authoring and preview only.
3

Edit your Markdown files

With the server running, open any .md file in your editor and make a change. Retype detects the change and reloads the browser automatically.Retype supports standard Markdown plus a set of extended components such as callouts, tabs, and code blocks. For a full reference, see the Components page.
4

Build for production

When you are ready to publish, generate the static output files:
retype build
By default, the built site is written to a .retype folder in your project directory. This location is configurable via the output setting in retype.yml.The output is a plain HTML website with no server-side dependencies. Copy the .retype folder to any web host to publish.
You can host your Retype site for free using GitHub Pages, Cloudflare Pages, GitLab Pages, Netlify, or any other static hosting service.

​
Next steps

Configuration

Configure your project title, URL, navigation, and more using retype.yml.

Components

Explore callouts, tabs, code blocks, and other built-in content components.

Hosting

Deploy your site to GitHub Pages, Netlify, Cloudflare, or any static host.

Page configuration

Set per-page options like custom labels, icons, ordering, and visibility.

Build docs developers (and LLMs) love

Get started for freeTalk to us