Repository files navigation

Retype is a static website generator that builds a website based on simple Markdown (.md) text files. Focus on your writing while Retype builds the rest.

{.callout}

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

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

!!!Theretype.com website was generated using Retype. View thesource files used to generate this very page.!!!

{.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.”

A new Retype powered website can be up and running within seconds once Retype is installed, which itself takes only a few seconds. 👍

You can install Retype usingnpm,yarn, or thedotnet CLI.

From your command line, navigate to a folder location where you have one or more Markdown (.md) files, such as a GitHub project.

Next, choose one of the following tools to first installretypeapp and then start Retype by using theretype startcommand:

+++ NPM

npm install retypeapp --globalretype start

+++ Yarn

yarn global add retypeappretype start

+++ dotnet

dotnet tool install retypeapp --globalretype start

+++

That's it! Your new Retype website should be up and running.

!!!You will require eithernpm,Yarn, or thedotnet CLI to be installed before installing Retype. Only one of those three is required, although all three could be installed on your machine too. It's up to you. 🙌

All operating systems are supported: including Mac, Windows, and Linux.!!!

Retype has been built to be easy to use and should"just work" out-of-the-box without any special configuration 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 levelconfiguration usingretype.yml unlocks many more features and customization.

Pages areformatted using Markdown syntax and Retypecomponents. Page levelconfiguration is available, such as setting a custom navigationlabel oricon.

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 a basic HTML website that you can host on any web hosting service, or for free usingGitHub Pages,Netlify, orCloudflare. 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.

{{ include "snippets/support" }}