faq.md

icon	label
question	FAQ

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:

1. Up to 1000 pages can be built
2. The Powered by Retype branding can be removed
3. [!badge text="NEW" variant="info"] Password protected private and protected pages
4. [!badge text="NEW" variant="info"] Outbound link configuration
5. [!badge text="NEW" variant="info"] Breadcrumb navigation
6. [!badge text="NEW" variant="info"] Hub link
7. [!badge text="NEW" variant="info"] 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

npm install retypeapp --global
retype start

+++ yarn

yarn global add retypeapp
retype start

+++ dotnet

dotnet tool install retypeapp --global
retype start

+++

What is page metadata?

The page metadata is an optional block of configuration that can be placed at the top of any Markdown .md page. This block of configuration can also be referred to as the page Front Matter.

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.