retypeapp/retype repository overview

⁠Retype - Write On!

Retype⁠ is an ultra-high-performance static website generator that builds a website based on simple Markdown text files. Focus on your writing while Retype builds the rest.

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

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

⁠Quick start

You install⁠ Retype using npm⁠, yarn⁠, or the dotnet⁠ CLI.

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

Next, choose one of the following tools to first install retypeapp and then start Retype by using the retype start⁠ command:

⁠NPM

npm install retypeapp --global
retype start

⁠Yarn

yarn global add retypeapp
retype start

⁠dotnet

dotnet tool install retypeapp --global
retype start

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

⁠Features

⁠It just works

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

⁠Lightning fast

Don't blink. Retype was built for speed.

⁠Easy install

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

⁠Powerful

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

⁠Simple formatting

Pages are formatted⁠ using Markdown syntax and Retype components⁠. Page level configuration⁠ is available, such as customizing the navigation label⁠ or description⁠ used by search engines.

⁠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. After running retype start⁠, edit any .md file and see your changes appear in the browser almost instantly.

⁠Host anywhere

Retype generates a basic HTML website that you can self-host on any web hosting service, such as GitHub⁠ or GitLab⁠. 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 inside your organization.

⁠Support

If you find a defect, would like to submit a feature request, or have a technical support question, please create an Issue⁠ and we will investigate right away.

Do you have a general inquiry? Please feel free to contact us at [email protected]⁠.