README.md 在线预览

推送前先检查 README。打开文件、粘贴文本或丢进一个 GitHub 链接，徽章、表格、代码块、任务列表、提示块和 Mermaid 图表都按 GitHub 的样子渲染。

预览 README

免费 · 无需注册 · 在浏览器中运行，不上传任何内容

从 GitHub 链接打开的 markdown-it README，徽章、提示块和代码以 GitHub 深色主题渲染 — 直接从 GitHub 链接打开真实的 README：徽章、提示块、表格和代码都按 GitHub 的样子渲染。

从 GitHub 或本地打开 README

把 https://github.com/user/repo/blob/main/README.md 这样的 GitHub 网址粘贴到打开 → 从网址打开——查看器会自动换成 raw 文件链接并渲染。Gist 链接同样适用。本机的项目则把 README.md 拖到页面上，或把内容粘贴进编辑器。

GitHub 能渲染的，这里同样渲染

GitHub 风格 Markdown 是一种特定方言，README 大量依赖它的扩展：管道表格、- [ ] 任务列表、~~删除线~~、自动链接、> [!NOTE] / [!WARNING] 提示块、放长篇安装说明的 <details>、shields.io 徽章、页内标题锚点和带语言标签的代码块。这些都能渲染，标题 id 也与 GitHub 生成的一致，页内链接照常可用。GitHub 也会绘制的 Mermaid 图表同样支持。

提交前先修好

切到分栏布局，用实时预览编辑 README：工具栏插入表格和任务列表，快捷键处理加粗、链接和标题，大纲让你看清章节结构是否顺畅。满意后下载 .md，或复制渲染后的 HTML 用于项目站点。仓库里不只有 README：CLAUDE.md、AGENTS.md 这类给 AI 编程助手看的说明文件，打开方式完全一样——见 CLAUDE.md 查看器。

实际效果

GitHub 深色主题下的 Note、Important、Warning、Caution 提示块、引用和可折叠区块 — GitHub 风格提示块、引用和可折叠的 details 区块，GitHub 深色主题。

带语言标签和复制按钮的 TypeScript、Python、Bash 和 diff 代码块高亮 — 代码块带语言标签、50 多种语言的高亮和复制按钮——这是 One Dark 主题。

预览中渲染的 KaTeX 独立公式和 Mermaid 流程图 — KaTeX 公式和 Mermaid 流程图直接在文档里渲染。

使用步骤

1
把 GitHub README 链接粘贴到「打开 → 从网址打开」，或把文件拖到页面上。
2
阅读渲染后的效果，徽章、表格、代码和图表各就各位。
3
在分栏模式下编辑，然后下载更新后的 README.md。

你会得到什么

自动转换 GitHub 链接

blob 和 Gist 网址自动变成 raw 文件。

完整 GFM

表格、任务列表、提示块、脚注、details、徽章、自动链接、表情。

Mermaid 图表

架构图和流程图直接渲染。

深色与浅色主题

看看 README 在 GitHub 深色和浅色下分别什么样。

带预览编辑

修好排版问题，下载修正后的文件。

隐私

本地文件不离开浏览器；网址抓取不保存。

常见问题

效果会和 GitHub 完全一样吗？

Markdown 规则和标题 id 与 GitHub 风格 Markdown 一致，GitHub 浅色 / 深色主题用的是 GitHub 的配色。间距可能有细微差别，但结构、表格、代码和提示块渲染相同。

可以预览私有仓库的 README 吗？

通过网址不行，因为服务器无法向 GitHub 认证。把文件下载后拖到页面上即可——它留在你的设备上。

相对路径的图片能显示吗？

绝对网址的图片可以显示。本地文件里 docs/logo.png 这类相对路径无法解析；从 GitHub 网址打开时请使用 raw.githubusercontent.com 路径。

徽章会显示吗？

会。徽章就是绝对网址的普通图片，正常渲染。

能渲染 GitHub 之外网站的 README 吗？

可以，任何返回 Markdown 文件的公开网址都行。HTML 页面会被拒绝，提醒你换成 raw 链接。

随时可以开始

粘贴 Markdown、拖入文件或打开网址——预览立刻出现，所有内容都留在你的设备上。

打开 Markdown Viewer