{"id":13510110,"url":"https://github.com/retypeapp/retype","last_synced_at":"2026-04-04T10:36:54.685Z","repository":{"id":37482705,"uuid":"322947136","full_name":"retypeapp/retype","owner":"retypeapp","description":"Retype is an ultra-high-performance static site generator that builds a website based on simple text files. Made in Canada 🇨🇦.","archived":false,"fork":false,"pushed_at":"2026-04-02T05:31:45.000Z","size":108249,"stargazers_count":1325,"open_issues_count":117,"forks_count":217,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-04-02T05:32:05.654Z","etag":null,"topics":["cli","docs","documentation","documentation-generator","documentation-tool","documentation-website","notebooks","notes","retype","static-site-generation"],"latest_commit_sha":null,"homepage":"https://retype.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/retypeapp.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-12-19T22:12:10.000Z","updated_at":"2026-04-02T05:31:05.000Z","dependencies_parsed_at":"2023-02-16T01:15:22.180Z","dependency_job_id":"a5e5cbcc-92f8-413f-ba6d-5a7a276ddaef","html_url":"https://github.com/retypeapp/retype","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"purl":"pkg:github/retypeapp/retype","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retypeapp%2Fretype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retypeapp%2Fretype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retypeapp%2Fretype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retypeapp%2Fretype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/retypeapp","download_url":"https://codeload.github.com/retypeapp/retype/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/retypeapp%2Fretype/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31397055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","docs","documentation","documentation-generator","documentation-tool","documentation-website","notebooks","notes","retype","static-site-generation"],"created_at":"2024-08-01T02:01:24.479Z","updated_at":"2026-04-04T10:36:54.679Z","avatar_url":"https://github.com/retypeapp.png","language":"CSS","readme":"---\nlabel: \"Home\"\nicon: home\nbacklinks:\n  enabled: false\n---\n# Build docs from Markdown\n\n![](/static/retype-hero.png)\n\nRetype turns your Markdown `.md` files into a beautiful, fully-functional website. Write in plain Markdown, run one command, and you have a production-ready site you can host anywhere.\n\nNo coding is required and just one Markdown file, such as a `README.md`, will get you started.\n\n## Get Started\n\n[!card layout=\"signal\" text=\"Install Retype in seconds using npm, yarn, or dotnet\"](/guides/installation.md)\n[!card layout=\"signal\" title=\"Quick Start\" text=\"Get your first Retype site running in minutes\"](/guides/getting-started.md)\n[!card layout=\"signal\" title=\"CLI Reference\" text=\"All commands, flags, and options for the Retype CLI\"](/guides/cli.md)\n[!card layout=\"signal\" icon=\"gear\" title=\"Configuration\" text=\"Customize your site with the retype.yml project file\"](/configuration/project.md)\n[!card layout=\"signal\" text=\"Enrich your content with tabs, callouts, cards, and more\"](/components/components.md)\n[!card layout=\"signal\" icon=\"server\" title=\"Hosting\" text=\"Deploy your site to GitHub Pages, Netlify, Cloudflare, and more\"](/hosting/github-pages.md)\n\n## How it works\n\n\u003e\u003e\u003e Install Retype\n\nYou can install Retype using [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.\n\n+++ NPM\n```\nnpm install retypeapp --global\n```\n+++ Yarn\n```\nyarn global add retypeapp\n```\n+++ dotnet\n```\ndotnet tool install retypeapp --global\n```\n+++\n\n\u003e\u003e\u003e Start your project\n\nNavigate to any folder with Markdown files and run `retype start`.\n\n```\nretype start\n```\n\nRetype builds your site and opens it in the browser automatically.\n\n\u003e\u003e\u003e\n\n{.callout}\n\u003e “I don't want to write code to write docs, I just want to write docs.”\n\n## Why Retype?\n\nRetype is designed to get out of your way so you can focus on writing. There’s no complex build pipeline, no framework to learn, and no dependencies to maintain.\n\n### :icon-shield-check: It just works\n\nRetype has been built to be easy to use and should **_just work_** out-of-the-box without any special configuration, technical knowledge, or troublesome setup.\n\n### :icon-zap: Lightning fast\n\nDon't blink. Retype was built for speed.\n\n### :icon-gear: Easy install\n\n[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.\n\n### :icon-plug: Powerful\n\nProject level [configuration](/configuration/project.md) using **retype.yml** unlocks many more features and customization.\n\n### :icon-pencil: Simple formatting\n\nPages are formatted 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).\n\n### :icon-sync: Live reload\n\nIf a change is detected, such as editing and saving an `.md` file, your Retype website will be updated almost instantly within the browser.\n\n### :icon-server: Host anywhere\n\nRetype generates an HTML website that you can self-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.\n\n{.callout}\n\u003e “Retype is the perfect fit for my user persona - tech savvy non-devs who want to write using the best web standards out there.”\n\n!!!\nThe [retype.com](https://retype.com/) website was generated using Retype. View the [source](https://github.com/retypeapp/retype/blob/main/README.md) files used to generate this very page.\n!!!\n\n{{ include \"snippets/support\" }}\n","funding_links":[],"categories":["JavaScript","cli","documentation","CSS"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretypeapp%2Fretype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fretypeapp%2Fretype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fretypeapp%2Fretype/lists"}