Welcome to Retype
Retype is an
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.
You can install Retype using
yarn, or the
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 install
retypeapp and then start Retype by using the
retype watch command:
npm install retypeapp --global retype watch
yarn global add retypeapp retype watch
dotnet tool install retypeapp --global retype watch
That's it! Your new Retype website should be up and running.
You will require either npm, Yarn, or the dotnet 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. !!!
:icon-shield-check: 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.
:icon-zap: Lightning fast
Don't blink. Retype was built for speed.
:icon-gear: 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.
Project level configuration using
retype.yml unlocks many more Retype features and customization.
:icon-pencil: Simple formatting
:icon-sync: 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.
:icon-server: Host anywhere
Retype generates a basic HTML website that you can host on any web hosting service, or for free using GitHub Pages. 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.
Technical support questions are best asked in the Discussions. The discussions are monitored 24 hours a day and we will do our best to assist.
If you find a defect or would like to submit a feature request, please create an Issue and we will investigate right away.
Do you have a general inquiry? Please feel free to contact us at firstname.lastname@example.org.