Retype is an :sparkles: ultra-high-performance :sparkles: 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.
The retype.com website was generated using Retype.
A new Retype powered website can be up and running within seconds once Retype is installed, which itself takes only a few seconds. :+1:
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 install retypeapp --global
retype start
yarn global add retypeapp
retype start
dotnet tool install retypeapp --global
retype start
That's it! Your new Retype website should be up and running.
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 you need at least 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.
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.
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.
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.
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 hello@retype.com.
FAQs
Retype CLI.
The npm package retypeapp receives a total of 2,100 weekly downloads. As such, retypeapp popularity was classified as popular.
We found that retypeapp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.