Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/retypeapp/retype/llms.txt

Use this file to discover all available pages before exploring further.

Netlify is a popular web hosting platform with a generous free tier and automatic deployments from Git. This guide walks through connecting your GitHub repository to Netlify and deploying your Retype site.

​
Prerequisites

  • A GitHub repository containing your Retype project source files
  • The Retype Build Action configured to publish built output to a retype branch (see the GitHub Actions guide)
  • A Netlify account (free tier is sufficient)

​
Deployment

1

Add the Retype Build Action

Before connecting Netlify, set up the Retype GitHub Build Action in your repository. The action builds your site and pushes the output to a retype branch, which Netlify will then serve.
2

Sign up for Netlify

Go to netlify.com and sign up. You can authenticate directly with your GitHub account for a faster setup.After signing up, you will land on the Netlify dashboard.
3

Create a new site from Git

  1. Click Add new site > Import an existing project in the Netlify dashboard.
  2. Select GitHub as the Git provider.
  3. Authorize Netlify to access your GitHub account when prompted.
  4. Search for and select the repository you want to deploy.
4

Configure build settings

On the Build settings screen, configure the following:
SettingValue
Branch to deployretype
Build commandretype build
Publish directory.retype
If you are deploying from the retype branch (the pre-built output from the GitHub Action), you can leave the build command blank and set the publish directory to / — Netlify will serve the files directly without rebuilding.
5

Set environment variables (if using a Retype license key)

If your project requires a Retype license key, add it as an environment variable so it is not stored in your repository:
  1. In the Netlify dashboard, go to Site configuration > Environment variables.
  2. Click Add a variable.
  3. Set the key to RETYPE_KEY and the value to your license key.
Retype automatically reads the RETYPE_KEY environment variable during the build.
6

Deploy the site

Click Deploy site. Netlify will trigger an initial build and deploy. Once complete, your site will be available at a generated netlify.app subdomain shown in the dashboard.

​
Deploying updates

Once the site is connected, deployments are automatic. When you push changes to the configured branch, Netlify detects the update and starts a new build and deploy automatically. No manual action is required.

​
Custom domain

1

Add your domain in Netlify

In the Netlify dashboard, go to Domain settings and click Add custom domain. Enter your domain name and click Verify.
2

Configure DNS

Follow the prompts in the Netlify dashboard to update your domain’s DNS records. Netlify provides specific records (CNAME or A records) depending on whether you are using a subdomain or root domain.
3

Enable HTTPS

Netlify provisions a free TLS certificate via Let’s Encrypt automatically once DNS propagates. You can verify the certificate status under Domain settings > HTTPS.
4

Update retype.yml

Update the url in your retype.yml to your custom domain:
retype.yml
url: docs.example.com

​
Other hosting options

GitHub Pages

Deploy to GitHub Pages for free using the Retype Build Action.

Cloudflare Pages

Host on Cloudflare Pages with global CDN and DDoS protection.

Docker

Run Retype in a Docker container for flexible self-hosted deployments.

Build docs developers (and LLMs) love

Get started for freeTalk to us