This guide will have you up and running generating your own Retype website in just a few minutes.

Retype is a website generator that turns your Markdown .md files into a beautiful and functional documentation website. No coding required. Just write in Markdown and Retype handles the rest.

Retype is perfect for:

• Project documentation
• Knowledge bases
• API docs
• Personal blogs or notes
• Team wikis
• Self-publishing content

The first thing to complete is installing Retype.

Once you have Retype installed, you can verify using the following command to output the Retype version number:

retype --version

If the above is not working, then Retype is not installed.

Still using the command line, navigate to any folder with Markdown files:

cd your-project-folder

If you do not have Markdown files in that directory, create a new file such as the following readme.md:

:::code source="../samples/_includes/basic-page.md" :::

Then run the command retype start:

retype start

That's it! Retype will automatically:

1. Find your Markdown files
2. Build your website
3. Open it in your browser
4. Watch for changes and reload the browser automatically

Retype supports standard Markdown plus powerful extensions. Experiment with adding the following markdown to your page.

{{ include "snippets/markdown-sample" }}

Now with a basic introduction to Markdown options, explore the following Retype features:

[[Components]] : Rich content blocks like [[table]]s [[callout]]s, [[tab]]s, and much more.

Project settings : Project level configuration for your website

Page settings : Page level configuration options

To generate the static website files, run the following command:

retype build

By default, the files will be copied to a new .retype folder within your project, although this is configurable with the output setting.

The build should only take a few moments to complete. If you have your own web server, you can FTP or copy the files from the .retype directory to the web server.

You can also host your new website using [[GitHub Pages]], [[Cloudflare]], [[GitLab Pages]], [[Docker]], [[Netlify]], or absolutely any other web hosting service.

{{ include "snippets/support" }}