# Getting Started

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

# What is Retype?

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:

# Step 1: Installation

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.

# Step 2: Start Retype

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:

# Welcome!

This is a basic page, with only a title and some text content.

Then run the command retype start:

retype start

That's it! Retype will automatically:

Find your Markdown files
Build your website
Open it in your browser
Watch for changes and reload the browser automatically

# Next Steps: Add more content

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

# Basic Markdown

# Welcome!

This is a paragraph.

Both [internal](README.md) and [external](https://example.com) links work.

![Your logo](logo.png)

Another paragraph with **bold**, _italic_, ~~strikethrough~~, and `code` samples.

---

## Lists

- First item
- Second item
- Third item

1. First item
2. Second item
3. Third item

> "Cool! This is a quotation."

!!!
Need to draw attention to something? Use an alert.
!!!

# Components and Settings

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

Components: Rich content blocks like tables callouts, tabs, and much more.
Project settings: Project level configuration for your website
Page settings: Page level configuration options

# Hosting

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.

# Support

Do you have a technical support question, find a defect, or would like to make a feature request? Please create an issue to get the conversation started.

Do you have a general inquiry? Please feel free to contact us at hello@retype.com.

We ❤️ your feedback.

guide