Website review
This review may include AI-generated content and is not individually verified. Domain, certificate and other facts come from the observed data on this page.
What is Retype?
Retype is a documentation website builder that turns plain Markdown files into a finished, production-ready website. You write .md files, run one command, and Retype generates a static HTML site you can publish anywhere. It is aimed at people who want to write docs rather than build a site around them.
Who it suits
- Technical writers and developers who already keep content in Markdown.
- Small teams that want documentation without maintaining a build pipeline or a framework.
- Anyone who wants to keep files in their own repository and avoid vendor lock-in.
How it works in practice
Install the CLI with npm, Yarn, or the dotnet CLI, navigate to a folder containing Markdown, and run retype start. Retype builds the site and opens it in the browser, with live reload as you edit and save files. A single .md file is enough to start; a retype.yml project file unlocks broader configuration when you need it.
What you get beyond plain Markdown
- Components such as tabs, callouts, and cards for richer pages.
- Page-level options like custom navigation labels or icons.
- Static HTML output that can be self-hosted or deployed to services like GitHub Pages, Netlify, or Cloudflare.
Trade-offs
The Markdown-first approach is fast to adopt and easy to hand off, but it is not a general-purpose web framework. If your project needs application logic, a database, or heavy custom front-end work, a static documentation generator will feel constrained. Likewise, if your team prefers a visual editor over files in a repository, this model may not fit.
Next step
If you already have a folder of Markdown notes, install the CLI and run retype start in that folder. Seeing your existing content rendered as a site is the quickest way to judge whether the default styling and component set match what you need. For a broader comparison, look at Docusaurus and MkDocs.
How do I install and run Retype to build my first documentation site?
Install Retype globally with npm, Yarn, or the dotnet CLI, then run one command inside a folder that contains Markdown. Retype handles the build and opens a local preview in your browser, so a single .md file is enough to get a site running.
Install (choose one)
npm install retypeapp --globalyarn global add retypeappdotnet tool install retypeapp --global
Run it
- Open a terminal in any folder containing Markdown files.
- Run
retype start. - Retype builds the site and opens it automatically; saving an
.mdfile refreshes the browser almost instantly.
Typical first-project flow
- Create a folder, add
index.mdwith a heading and a paragraph. - Run
retype startand confirm the page renders. - Add more
.mdfiles as sections; Retype turns them into pages and navigation. - When ready to publish, generate the static HTML output and upload it to any web host, or deploy to GitHub Pages, Netlify, or Cloudflare.
Where configuration fits
retype.ymlat the project level controls site-wide settings and unlocks more customization.- Page-level settings in a file's front matter handle details like navigation labels or icons.
- Components such as tabs, callouts, and cards extend plain Markdown when you need richer pages.
Decision criteria
- Choose this approach if your content already lives in Markdown and you want a documentation site without learning a framework or maintaining a build pipeline.
- Look elsewhere if you need server-side rendering, a database, or an application framework rather than a content site.
Practical notes
- Install the CLI once per machine; the global command is then available in any project folder.
- Keep content in plain
.mdfiles so you can move hosts or tooling later. - The page notes a Pro tier exists at Retype; check that page directly for current plan details rather than assuming what is included.
Next step: create a folder with a single index.md, run retype start, and confirm the live reload works before adding structure.
Can I host a Retype site for free, and which platforms are supported?
Yes. Retype generates a static HTML site, so you can host it for free on several common platforms — and you can also self-host it on any web server you control.
Free hosting options mentioned by Retype
- GitHub Pages
- Netlify
- Cloudflare
Because the output is plain HTML, there is no special server-side software or external dependency required. Your Markdown files remain the source, and you can move the built site elsewhere later without being locked into one host.
How to choose
| Option | Best for | Trade-off to consider |
|---|---|---|
| GitHub Pages | Documentation kept in a GitHub repository | Tied to your GitHub workflow; less convenient if your content lives elsewhere |
| Netlify | Teams that want a simple deploy pipeline and previews | You are relying on a third-party platform for builds and hosting |
| Cloudflare | Sites already using Cloudflare for DNS or performance | Slightly more setup if you are new to Cloudflare |
| Any web server | Full control, internal networks, or custom infrastructure | You handle deployment, HTTPS, and server maintenance yourself |
Practical next step
If you already keep Markdown in Git, start with GitHub Pages. If you want the least friction for a public docs site and may later add custom domains or preview builds, try Netlify. If your domain or security setup already runs through Cloudflare, host there.
One caveat: free tiers can change, and “free” may come with limits on build minutes, bandwidth, or commercial use. Check the current terms of the platform you pick before committing. For a quick trial, run retype start locally first, confirm the generated site looks right, then deploy the output to your chosen host.
How do I customize my Retype site's navigation, layout, and components using retype.yml?
Customize a Retype site through retype.yml, which lives at the project root and applies settings across every page. Navigation and layout options are configured there, while most components are inserted directly into your Markdown files. Retype builds on a single .md file and adds project-level configuration once you need more control.
Navigation in retype.yml
The nav section controls the top navigation bar, and sidebars are generated from your file and folder structure. Typical tasks:
- Add external links or standalone pages to the top bar with
nav. - Use page-level front matter to set a custom navigation label or icon.
- Reorder or group pages by arranging files and folders, or by adding front matter labels.
Layout and site-wide settings
Layout and branding are set once in retype.yml rather than per page:
- Branding:
brandingholds the site title, logo, and colors. - Links:
linksadds footer or header items such as a repository URL. - Output and behavior:
output,url, and similar keys control where the built HTML goes and how the site is served.
Components
Components such as tabs, callouts, and cards are not configured in retype.yml; they are written into your Markdown using Retype's component syntax. Configuration only supplies the surrounding theme, so keep component markup in the .md files.
A practical first pass
- Run
retype startto confirm the site builds. - Create
retype.ymlat the root. - Set
brandingandnavfirst, since those change what visitors see immediately. - Preview with live reload, then adjust page front matter for labels and icons.
When to use it
Choose retype.yml when you want consistent navigation and branding across many pages without touching each file. If you only need a handful of pages, default structure plus front matter may be enough. Retype's CLI, configuration, and components are documented at Retype, including hosting on GitHub Pages, Netlify, or Cloudflare.
Does Retype have a paid Pro version, and what does it include compared to the free version?
Retype does have a paid Pro tier alongside its free version. The free version is the core Markdown-to-website builder: you install the CLI, point it at a folder of .md files, run retype start, and get a production-ready HTML site you can host anywhere — including GitHub Pages, Netlify, or Cloudflare. That free tier already covers project configuration via retype.yml, page-level settings like custom navigation labels or icons, live reload, and content components such as tabs, callouts, and cards.
What Pro adds is not spelled out in the page evidence here beyond a link to its pricing page, so treat the free/paid boundary as something to verify directly rather than assume. What can be said confidently is the model: the free version is not a crippled trial, and the paid tier is positioned as an upgrade for teams or sites needing more than the out-of-the-box build.
How to decide
- Choose free if you are writing documentation, a handbook, or a knowledge base and are happy hosting static HTML yourself. The "no vendor lock-in" and "plain Markdown files you own" framing is the real selling point: your content stays portable regardless of tier.
- Check Pro before committing if you need anything beyond a single-author static site — the pricing page is the only reliable source for what's gated. Don't infer Pro features from the free feature list.
A practical next step: build a small test site on the free tier first, using Retype's own docs as the reference, and only then compare against the Pro pricing page. If the free build already meets your needs, the paid question becomes moot; if it doesn't, you'll know exactly which feature you're paying for.
Can I use Retype without writing code or learning a framework, and does it lock me into proprietary formats?
Yes. Retype is built around plain Markdown files, so you write .md content and run one command (retype start) to build and preview a site. There is no framework to learn and no coding required for a standard documentation site; project-level customization lives in a retype.yml file, and page-level options such as navigation labels or icons are configured in the Markdown front matter.
On lock-in, the product describes the opposite: your content stays in plain Markdown files that you own and control, with no proprietary formats. Retype generates a static HTML website that you can self-host on any web server or deploy to services such as GitHub Pages, Netlify or Cloudflare. That means you can stop using Retype and keep your source content, though any Retype-specific components you rely on would need to be converted for another generator.
Where the trade-off sits
- Markdown-first is ideal for writers, technical teams and small projects that want docs published quickly without a design or frontend workflow.
- Configuration and components are opt-in: you can keep everything as simple Markdown, or add
retype.ymland components when you need tabs, callouts or cards. - The main constraint is that you are adopting Retype's build and component conventions, even if the underlying text remains portable.
Next step: try it on a folder containing a single .md file and run retype start. If the output looks right, add a retype.yml only when you actually need site-wide settings. For a fuller picture of the workflow, see Retype.
User reviews (0)