v4.5-pre
Powered by

Build docs from Markdown

Retype turns your Markdown .md files into a beautiful, fully-functional website. Write in plain Markdown, run one command, and you have a production-ready site you can host anywhere.

No coding is required and just one Markdown file, such as a README.md, will get you started.

Get Started

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

How it works

You can install Retype using npm, Yarn, or the dotnet CLI.

npm install retypeapp --global
 
yarn global add retypeapp
 
dotnet tool install retypeapp --global

Navigate to any folder with Markdown files and run retype start.

retype start

Retype builds your site and opens it in the browser automatically.

“I don't want to write code to write docs, I just want to write docs.”

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.

It just works

Retype has been built to be easy to use and should just work out-of-the-box without any special configuration, technical knowledge, or troublesome setup.

Lightning fast

Don't blink. Retype was built for speed.

Easy install

Installation takes only a few seconds. Then all you need is one Markdown .md file which Retype will start building a new website from.

Powerful

Project level configuration using retype.yml unlocks many more features and customization.

Simple formatting

Pages are formatted using Markdown syntax and Retype components. Page level configuration is available, such as setting a custom navigation label or icon.

Live reload

If a change is detected, such as editing and saving an .md file, your Retype website will be updated almost instantly within the browser.

Host anywhere

Retype generates an HTML website that you can self-host on any web hosting service, or for free using GitHub Pages, Netlify, or Cloudflare. No special server-side software or external dependencies are required. You can host your Retype site as a public website or as a private website within your organization's network.

“Retype is the perfect fit for my user persona - tech savvy non-devs who want to write using the best web standards out there.”

Support

Do you have a technical support question, find a defect, or would like to make a feature request? Please create an issue to get the conversation started.

Do you have a general inquiry? Please feel free to contact us at hello@retype.com.

We ❤️ your feedback.