从满是符号的源文,到可以直接阅读的文档
MD 文件是使用 Markdown 语法编写的纯文本。普通文本编辑器会显示标题符号、星号和链接语法,查看器则把这些结构呈现成可阅读的文档。你可以打开本机文件,也可以粘贴 README 或笔记的原始内容。
这里优先展示阅读结果。先用目录或搜索找到需要的段落,再调整阅读宽度和字体;确实需要修改时,点击“在编辑器中继续”,源文会在当前浏览器内交给已有编辑器。
围绕阅读安排的查看功能
先打开文件,再开始阅读
支持 .md、.markdown 和 .txt 文件,也可以拖入文件。没有文件时,展开“粘贴 Markdown”即可输入源文。
定位章节和文字
目录根据真实标题生成,重复标题有各自的链接。搜索按原样匹配文字,可前后跳转;公式和图表图形不纳入文字搜索。
适合长文的阅读设置
选择字体、字号、行距、文档宽度,以及纸白、暖米色或深色底色。全屏阅读让正文占据主要空间,按 Escape 可以退出。
保留源文或阅读副本
下载 MD 保留可编辑的原始内容,下载 HTML 保存阅读副本。HTML 可包含目录,搜索高亮不会进入保存的文档。
用这些文档检查阅读效果
阅读一份项目 README
用短文档检查目录、列表和链接。
# 项目 README ## 安装 运行 `npm install`。 ## 使用条件 - 现代浏览器 - 本机 Markdown 文件 ## 说明 参考 [CommonMark 指南](https://commonmark.org/help/)。
- 使用目录进入“使用条件”。
- 搜索“浏览器”并跳转到对应文字。
同名章节也能分别定位
相同的标题名称不会指向同一个位置。
# 文档评审 ## 备注 第一位评审者的意见。 ## 备注 第二位评审者的意见。 ```text ## 代码里的这一行不是标题 ```
- 两个“备注”目录项分别定位到各自章节。
- 代码块里的标题语法不出现在目录中。
打开、定位,再保留一份副本
打开文件或粘贴源文
选择 MD 文件、拖入文件,或展开粘贴区域。也可以先载入示例,检查标题、代码与图表的阅读效果。
阅读并定位内容
使用目录进入章节,或搜索一句话。外部图片默认关闭,开启后会向图片所属站点发起请求。
保存或继续编辑
下载 MD 保留源文,下载 HTML 留下阅读副本。“在编辑器中继续”仅在当前浏览器传递文本,不会生成公开分享地址。
分享前,检查这几项
| 内容 | 建议操作 | 可以期待的结果 |
|---|---|---|
| 图片 | 先检查图片路径,再决定是否加载外部图片。 | 单独的 MD 文件无法解析本机相对路径图片。 |
| 目录 | 试试同名标题和代码块内的标题语法。 | 只有真实标题进入目录,同名章节拥有不同链接。 |
| 导出 | 打开下载的 HTML 并点击目录链接。 | 目录定位到副本自身的章节,不包含网站操作栏。 |
打开和阅读 MD 文件的常见问题
怎么在线打开 MD 文件?
点击“打开文件”或把 .md 文件拖到工具中,也可以粘贴 Markdown 原文。浏览器读取并渲染文本,不需要安装桌面软件。
只想查看 README.md,不编辑可以吗?
可以。打开下载的 README.md 或粘贴其原始内容即可,页面默认以阅读为主,需要修改时再进入编辑器。
为什么 README 中的本地图片没有显示?
images/logo.png 等路径依赖同目录的其他文件,单个 MD 文件不包含这些图片。请使用内嵌图片或完整的 HTTPS 地址;外部地址需要开启图片加载选项。
手机也可以查看吗?
可以。窄屏上目录会排在正文上方,可从设备存储选择文件或粘贴源文。不同手机的文件选择器可能显示不同的文件类型。
文档会上传到服务器吗?
打开、渲染、搜索和 MD/HTML 下载都在浏览器内完成。开启外部图片会向图片站点发送请求;网站本身仍会加载通常使用的统计和广告服务。
下载 HTML 会带上搜索高亮吗?
不会。导出使用搜索标记之前的文档内容,可以选择包含目录;字体和字号会在导出支持范围内沿用阅读设置。
文档会怎样被处理
- MD 阅读、搜索及 HTML/MD 下载都在本机完成。
- 进入编辑器时临时使用当前标签页的会话存储,编辑器读取后会删除这份传递值。
- 外部图片初始关闭;开启后请求发往图片所属站点,文档渲染仍在本地完成。
格式参考CommonMark 入门GitHub Flavored Markdown 规范
反馈可复现的问题请说明浏览器、所选设置,并附上不含隐私的最小示例。不要通过邮件发送私密文档。