Tag: guide

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

Adding a blog to your Retype website is as quick as adding a new .md file to your project.

Add a simple GitHub Action to your project to automate the building and deployment of your Retype powered website. Currently, there are two Retype related GitHub Actions: The first, Build Action will automatically build your Retype powered website with each new change that is committed.

Retype automatically generates an llms.txt file for your project when you build your site. The generated file is published to the root of your site, such as /llms.txt, and gives AI tools a clean map of the important documentation pages in your project. Instead of asking a tool to crawl the visual HTML site, llms.txt points directly to Markdown-friendly page URLs that are easier to read, summarize, index, and reference.

Markdown .md pages are plain text documents with a simple human readable syntax that aims to make writing for the internet easier. No special software is required to create a .md file. Any basic text editor will do. Just save the file with a .md file extension.

Retype for Obsidian integrates the Retype app directly into Obsidian and your vault. Start, stop, and build your Retype documentation site directly from the Obsidian sidebar, without switching to a terminal. Install directly from Obsidian Community plugins website or continue reading to get set up.

The Retype CLI is clean and simple. The majority of the time you will run just one command: retype start The --help option can be passed with any command to get additional details, for instance retype start --help will return all options for the retype start command.

Retype's theme system allows you to customize the visual appearance of your website by overriding theme variables. With themes, you can adjust colors, spacing, typography, and other design elements to match your brand or project preferences.

If you encounter issues while using Retype, this guide will help you identify and resolve common problems quickly. Follow the steps below to troubleshoot and get your project back on track.

Cloudflare is a popular website used to host your websites and protect them, It's used by millions of people also using Retype.

Using a docker container has numerous advantages, including:

Add a simple GitHub Action to your project to automate the building and deployment of your Retype powered website to any FTP host. Two Retype GitHub actions will be involved in the process of sync+deploy: The first, Build Action will automatically build your Retype powered website with each new change that is committed.

Hosting your Retype built website on GitHub Pages is free and simple to setup.

Add a simple CI/CD pipeline to the project to automate the building and deployment of the Retype powered website via Gitlab Pages.

Netlify is a popular web hosting platform that allows you to deploy your website easily. In this tutorial, we will go through the steps to sign up, configure, and deploy a Retype built website on Netlify, using GitHub as our version control system. We will assume that the source files for the website are available on the retype branch of the GitHub repository.