| label | Home | |
|---|---|---|
| icon | home | |
| backlinks |
|
-
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.
!card layout="signal" text="Install Retype in seconds using npm, yarn, or dotnet" !card layout="signal" title="Quick Start" text="Get your first Retype site running in minutes" !card layout="signal" title="CLI Reference" text="All commands, flags, and options for the Retype CLI" !card layout="signal" icon="gear" title="Configuration" text="Customize your site with the retype.yml project file" !card layout="signal" text="Enrich your content with tabs, callouts, cards, and more" !card layout="signal" icon="server" title="Hosting" text="Deploy your site to GitHub Pages, Netlify, Cloudflare, and more"
Install Retype
You can install Retype using npm, Yarn, or the dotnet CLI.
+++ NPM
npm install retypeapp --global
+++ Yarn
yarn global add retypeapp
+++ dotnet
dotnet tool install retypeapp --global
+++
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.
{.callout}
“I don't want to write code to write docs, I just want to write docs.”
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.
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.
Don't blink. Retype was built for speed.
Installation takes only a few seconds. Then all you need is one Markdown .md file which Retype will start building a new website from.
Project level configuration using retype.yml unlocks many more features and customization.
Pages are formatted using [[Markdown]] syntax and Retype components. Page level configuration is available, such as setting a custom navigation label or icon.
If a change is detected, such as editing and saving an .md file, your Retype website will be updated almost instantly within the browser.
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.
{.callout}
“Retype is the perfect fit for my user persona - tech savvy non-devs who want to write using the best web standards out there.”
!!! The retype.com website was generated using Retype. View the source files used to generate this very page. !!!
{{ include "snippets/support" }}