| label | icon |
|---|---|
Home |
home |
This is a comprehensive demonstration of Retype, an ultra-high-performance static site generator that builds a website based on simple Markdown (.md) text files.
Retype is a modern static site generator that transforms your Markdown files into beautiful, fast, and functional websites. Focus on your writing while Retype builds the rest.
- 🚀 Ultra-fast - Lightning-fast performance
- 📝 Markdown-based - Simple and intuitive content creation
- 🎨 Beautiful themes - Professional and customizable designs
- ⚡ Live reload - See changes instantly during development
- 🔍 Built-in search - Powerful full-text search functionality
- ✨ Rich components - Alerts, tabs, panels, and more
You can install Retype using npm, yarn, or the dotnet CLI.
From your command line, navigate to a folder location where you have one or more Markdown (.md) files, such as a GitHub project.
Next, choose one of the following tools to first install retypeapp and then start Retype by using the retype start command:
+++ NPM
npm install retypeapp --global
retype start
+++ Yarn
yarn global add retypeapp
retype start
+++ dotnet
dotnet tool install retypeapp --global
retype start
+++
That's it! Your new Retype website should be up and running.
!!! You will require either npm, Yarn, or the dotnet CLI to be installed before installing Retype. Only one of those three is required, although all three could be installed on your machine too. It's up to you. 🙌
All operating systems are supported, including Mac, Windows, and Linux. !!!
Navigate through our demo to see Retype's capabilities:
- Getting Started - Learn the basics
- Components Demo - See all available components
- Guides - Detailed how-to guides
- API Reference - API documentation examples
!!!success Success Story Thousands of developers and teams use Retype to build documentation, knowledge bases, blogs, and project sites with minimal effort and maximum impact. !!!
Ready to get started? Check out our Getting Started guide!