v4.6
Powered by

Frequently Asked Questions

Is Retype free to use?

Yes, Retype is free to use with both open-source and commercial projects.

With Retype Pro, you get all the Pro Features, including:

  1. The Powered by Retype branding can be removed
  2. Password protected private and protected pages
  3. Outbound link configuration
  4. Breadcrumb navigation
  5. Hub link
  6. 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 and Installation guides for detailed instructions.

If you are using Obsidian, you can also install Retype using the Retype for Obsidian plugin.

If you ain't got no time for that, just run the following 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 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.

sample.md
---
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.