Frequently Asked Questions
Is Retype free to use?
Yes, Retype is free to use with both open-source and commercial projects up to 100 pages per project.
With Retype Pro, you get the following additional features:
- Up to 1000 pages can be built
Powered by Retypebranding can be removed
- Outbound link configuration
- Breadcrumb navigation
- Hub link
- Table of Contents configuration
How do I install Retype?
Installing Retype is super simple and takes only a few seconds. Please see our Getting Started guide for detailed installation instructions.
If you ain't got no time for that, just run the following two commands on a folder that contains at least one .md file, depending on your preferred package manager.
npm install retypeapp --global retype start
yarn global add retypeapp retype start
dotnet tool install retypeapp --global retype start
What is page metadata?
The block of page metadata must be the first item at the top of the .md page and must be added between
--- lines above and below the configs.
--- icon: rocket --- # Your page title here
The page metadata is completely optional and typically only required when you want to override the Retype defaults.
You can also add page metadata into a separate .yml file, see page config options.