Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/retypeapp/retype
Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.
https://github.com/retypeapp/retype
cli docs documentation documentation-generator documentation-tool documentation-website notebooks notes retype static-site-generation
Last synced: about 1 month ago
JSON representation
Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files.
- Host: GitHub
- URL: https://github.com/retypeapp/retype
- Owner: retypeapp
- License: other
- Created: 2020-12-19T22:12:10.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T17:27:37.000Z (about 2 months ago)
- Last Synced: 2024-10-18T13:29:49.335Z (about 2 months ago)
- Topics: cli, docs, documentation, documentation-generator, documentation-tool, documentation-website, notebooks, notes, retype, static-site-generation
- Language: JavaScript
- Homepage: https://retype.com
- Size: 39.1 MB
- Stars: 1,062
- Watchers: 8
- Forks: 204
- Open Issues: 168
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - retypeapp/retype - Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files. (documentation)
- jimsghstars - retypeapp/retype - Retype is an ✨ ultra-high-performance✨ static site generator that builds a website based on simple text files. (JavaScript)
README
---
label: "Welcome"
icon: home
---
# Welcome to Retype
[Retype](https://retype.com/) is an :sparkles: ultra-high-performance :sparkles: static website generator that builds a website based on simple Markdown text files. Focus on your writing while Retype builds the rest.
{.callout}
> “Retype is the perfect fit for my user persona -\
> tech savvy non-devs who want to write using the best web standards out there” *- jonnyfeelgood*
No coding is required and just one Markdown file, such as a [README.md](https://www.makeareadme.com/), will get you started.
The [retype.com](https://retype.com/) website was generated using Retype. View the [source](https://github.com/retypeapp/retype/blob/main/README.md) used to generate this very page.
{.callout}
> “I don't want to write code to write docs,\
> I just want to write docs.” *- rab-dev*
A new Retype powered website can be up and running within seconds once Retype is installed, which itself takes only a few seconds. :+1:
---
## Quick start :zap::zap::zap:
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](/guides/cli.md#retype-start):
+++ 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](https://www.npmjs.com/get-npm), [Yarn](https://classic.yarnpkg.com/en/docs/install/), or the [dotnet](https://dotnet.microsoft.com/download/dotnet-core) 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. :raised_hands:
All operating systems are supported: including Mac, Windows, and Linux.
!!!
---
## Features
#### :icon-shield-check: It just works
Retype has been built to be easy to use and should _"just work"_ out-of-the-box without any special configuration or troublesome setup.
#### :icon-zap: Lightning fast
Don't blink. Retype was built for speed.
#### :icon-gear: Easy install
[Installation](/guides/getting-started.md) takes only a few seconds. Then all you need is one Markdown **.md** file which Retype will start building a new website from.
#### :icon-plug: Powerful
Project level [configuration](/configuration/project.md) using **retype.yml** unlocks many more features and customization.
#### :icon-pencil: Simple formatting
Pages are [formatted](/guides/formatting.md) using Markdown syntax and Retype [components](/components/components.md). Page level [configuration](/configuration/page.md) is available, such as setting a custom navigation [`label`](/configuration/page.md#label) or [`icon`](/configuration/page.md#icon).
#### :icon-sync: Live reload
If a change is detected, such as editing and saving an **.md** file, your Retype website will be updated almost instantly within the browser.
#### :icon-server: Host anywhere
Retype generates a basic HTML website that you can host on any web hosting service, or for free using [GitHub Pages](/hosting/github-pages.md), [Netlify](/hosting/netlify.md), or [Cloudflare](/hosting/cloudflare.md). No special server-side software or external dependencies are required. You can host your Retype site as a public website or as a private website within your organization's network.
---
## Support
Do you have a technical support question, found a defect, or would like to make a feature request? Please create an [issue](https://github.com/retypeapp/retype/issues) and we will investigate right away.
Do you have a general inquiry? Please feel free to contact us at [email protected].
We :heart: feedback.