retypeapp/retype

Retype - 专注创作，轻松建站

Retype 是一款超高性能静态网站生成器，可基于简单的Markdown文本文件构建网站。让您专注于内容创作，Retype负责处理网站构建的其余部分。

!Retype

无需编码，只需一个Markdown文件（如README.md）即可快速开始。

retype.com 官方网站即由Retype生成。

安装Retype仅需几秒，之后新的Retype网站可在几秒内启动并运行。:+1:

镜像概述与主要用途

Retype Docker镜像提供容器化部署方式，无需本地安装依赖即可快速使用这款超高性能静态网站生成器。它基于Markdown文件自动构建网站，专注于内容创作体验，同时提供丰富的自定义能力，帮助用户在几秒内完成静态网站的搭建与预览。

核心功能与特性

开箱即用

设计初衷是简单易用，无需特殊配置或繁琐设置，开箱即可正常运行。

极速性能

Retype为速度而生，构建和更新网站的响应速度极快。

安装便捷

容器化部署简化安装流程，无需手动配置开发环境，秒级启动。

功能强大

通过项目级配置文件retype.yml可解锁更多高级功能，支持深度自定义。

格式简洁

页面使用Markdown语法和Retype组件格式化，支持页面级配置（如导航标签、搜索引擎描述等）。

实时重载

检测到Markdown文件变更（如编辑保存）时，网站会在浏览器中实时更新。

随处托管

生成纯静态HTML网站，可托管于任何Web服务（如GitHub Pages、GitLab Pages），无需服务端依赖，支持公开或私有部署。

使用场景与适用范围

• 项目文档：为GitHub/GitLab项目快速生成美观的技术文档网站
• 个人博客：基于Markdown写作，轻松构建个性化博客
• 知识库：企业/团队内部的文档中心、帮助系统或知识库
• 静态展示站：需快速上线且以文本内容为主的宣传展示网站

使用方法与配置说明

前提条件

• 已安装Docker引擎
• 本地项目目录包含至少一个Markdown文件（如README.md）

Docker快速启动

通过以下命令运行Retype容器，挂载本地Markdown文件目录并启动服务：

bash
docker run -it --rm -p 3000:3000 -v $(pwd):/app docker.xuanyuan.run/retypeapp/retype retype start

参数说明：

• -it：交互式运行，支持实时日志输出
• --rm：容器停止后自动删除
• -p 3000:3000：映射容器3000端口（Retype默认服务端口）到主机
• -v $(pwd):/app：挂载当前工作目录（含Markdown文件）到容器内/app目录
• retypeapp/retype：Retype官方Docker镜像
• retype start：启动Retype开发服务器，监听文件变更并实时更新

访问网站

服务启动后，通过浏览器访问 http://localhost:3000 即可预览网站。编辑本地Markdown文件并保存，页面将自动刷新。

高级配置

在项目目录创建retype.yml文件进行项目级配置，示例配置：

yaml
site:
  title: "我的Retype网站"
  description: "使用Retype构建的静态网站"
navigation:
  items:
    - label: "首页"
      path: README.md
    - label: "文档"
      path: docs/

详细配置选项参考Retype官方配置文档。

支持

• 缺陷报告/功能请求：通过https://github.com/retypeapp/retype/issues%E6%8F%90%E4%BA%A4
• 技术支持：发送邮件至***咨询

更多帮助资源请访问Retype官方文档。