按 GitHub 的渲染方式预览 README.md:支持提示块、表情短码、任务列表、脚注、折叠块和标题锚点,可以切换浅色和深色主题。输入仓库地址可以直接加载 README,相对路径的图片和链接会改写成仓库地址,并检查失效的相对链接。从零开始写 README 可以用 README 生成器。
也可以直接在下方粘贴 Markdown。从 GitHub 加载需要能访问 raw.githubusercontent.com。
| 写法 | 效果 |
|---|---|
> [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING]、[!CAUTION] | 带图标和颜色的提示块,写在引用块的第一行 |
:rocket:、:tada: | 表情短码,渲染成对应的表情 |
- [x] 已完成 | 任务列表 |
文字[^1] 和 [^1]: 说明 | 脚注,显示在文末 |
<details><summary>标题</summary>…</details> | 可以折叠的内容 |
<picture> 配合 prefers-color-scheme | 浅色、深色主题下显示不同的图片 |
[文字](#标题) | 跳转到页面中的标题,锚点为标题的小写形式,空格换成 - |
docs/guide.md、./images/logo.png 在 GitHub 上相对于 README 所在目录解析,在 npm、文档网站等其他地方会失效。发布到 npm 的包建议使用完整网址。<picture> 准备两套图片,在右上角切换深色预览检查效果。生成 README 请用 README 生成器,转成网页或公众号排版请用 Markdown 转 HTML,检查写法问题可以用 Markdown 语法检查。
在左侧粘贴 README.md,右侧按 GitHub 的样式实时预览,可以切换浅色和深色主题、显示目录;输入 GitHub 仓库(如 vuejs/core)点“加载 README”可以直接读取仓库中的 README,相对路径会改写成仓库地址;下方列出失效的页内链接和相对路径问题。
把内容粘贴到左侧,右侧按 GitHub 的样式渲染,还能切换深色主题。
在引用块第一行写 [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING] 或 [!CAUTION]。
相对路径只在 GitHub 仓库中有效,加载仓库后工具会把它们改写成完整地址。
标题转为小写、去掉标点、空格换成 -,例如 ## 快速开始 的锚点是 #快速开始。
尽量模拟 GitHub 的渲染效果,但不支持 Mermaid 图表、数学公式等 GitHub 额外的渲染;表情短码只收录常用的一部分;加载仓库只支持公开仓库。
粘贴的内容只在浏览器本地渲染;加载仓库时浏览器会直接向 raw.githubusercontent.com 请求文件。
加载失败时,确认仓库是公开的,并在分支框中填写正确的默认分支名;网络无法访问 GitHub 时可以手动粘贴内容。
GitHub Actions 工作流生成器 · HMAC 签名生成与验证 · CSS 媒体查询生成器 · README 生成器 · 全部开发工具