先阅读文档,再决定要修改什么
收到 README 或笔记,只想先查看内容时,可以打开 .md 文件并选择“预览”,直接阅读排版后的文档。需要修改时再切换到“编辑”或“分屏”,源文始终可以检查和保存。
常用操作支持快捷键,已有草稿可以直接打开文件。本地草稿由你主动开启,只属于当前浏览器配置,不等于云端备份。
让源文保持可见的编辑工具
查看 MD 文件,不必先编辑
预览模式会隐藏源文面板,方便阅读标题、列表、表格与代码。看完后仍可切回编辑,文档内容不会因切换视图而丢失。
复杂内容有插入起点
生成基础表格,加入行内或独立公式、Mermaid 示例,或内嵌本地栅格图片,再直接修改对应源文。
边写边检查预览效果
分屏模式同时显示源文和排版结果,输入稍作停顿后更新预览,便于检查表格对齐、代码块和支持的公式。较长文档暂停自动预览时,可以手动更新。
按自己的方式工作
支持编辑、预览、分屏与专注模式,可调整字体与文档缩放,随时下载 Markdown 保留可迁移的副本。
从真正要交付的文档开始
项目 README
先阅读 README,检查说明是否清楚;需要修改安装步骤时,再切换到分屏。
# 项目名称 用一句话说明**这个项目解决什么问题**。 ## 开始使用 ```bash npm ci ``` ## 下一步 - [ ] 补充可运行示例 - [ ] 检查使用说明
- 首段说明用途
- 命令放入代码块
- 清单有明确动作
包含图表的决策笔记
让文字解释与工作流程保存在同一份源文件里。
# 评审流程 ```mermaid flowchart LR A[起草] --> B[检查] B --> C[分享] ``` 分享前由评审者核对关键结论。
- 图表语法正确
- 节点文字清楚
- 正文解释图表含义
打开、预览并保存文档
打开文件或粘贴内容
点击“打开文件”选择 .md 文档,也可以直接粘贴 Markdown。阅读 GitHub README 时,请先保存原始文件;输入网页地址不会自动导入文档。
选择阅读或分屏编辑
只阅读时选择“预览”,需要修改时选择“分屏”,边写边检查效果。标题、链接、列表和表格可以从工具栏插入,不必记住所有语法。
保留可以继续编辑的副本
下载 MD,把源文件保存在自己的设备上。需要排版后的文件时可下载 HTML,准备分享时可使用 PDF 工具。本机草稿保存由你选择,不能代替文件备份。
分享前,检查这几项
| 内容 | 建议操作 | 可以期待的结果 |
|---|---|---|
| 误加的格式 | 使用工具栏后检查对应源文。 | 加粗和列表仍是普通 Markdown,可随时手动修改。 |
| 草稿恢复 | 开启保存后编辑一小段,再刷新并恢复。 | 草稿依赖当前设备,可能被浏览器清理。 |
| AI 生成的内容 | 核实事实,修正不完整代码围栏或不支持的公式。 | 排版提高可读性,不等于内容事实已经正确。 |
这个任务的常见问题
只想查看 MD 文件,不编辑也可以吗?
可以。点击“打开文件”选择 .md 文档,再切换到“预览”,就能直接阅读排版后的内容,不必修改源文。需要调整时再切回编辑或分屏即可。
怎样边写 Markdown 边查看效果?
打开文件或粘贴源文后选择“分屏”。输入稍作停顿,右侧就会更新效果。较长文档暂停自动预览时,点击“更新预览”即可。编辑与查看都在浏览器中完成,无需上传文档。
不熟悉 Markdown 语法也能使用吗?
工具栏可插入常用语法,示例提供起点。保留可见源文,也方便了解每个按钮具体修改了什么。
草稿保存在哪里?
只在主动开启本地保存时写入当前浏览器,不跨设备同步;清除浏览器存储后草稿也会消失。需要长期保留时请下载 MD。
特别长的文档如何处理?
你仍可编辑和下载源文。为保持编辑响应,自动预览可能暂停;需要查看时可以手动更新。
支持 HTML 标签吗?
支持用于下划线、上标、下标、键盘按键和高亮的少量无属性格式标签,其他原始 HTML 按文本显示。
可以编写数学公式和流程图吗?
可以渲染 KaTeX 支持的公式与 Mermaid 代码块。错误会被标出,便于在渲染导出前修正源文。
文档会怎样被处理
- 编辑器和预览在浏览器中运行。
- 本地草稿保存由你开启,也可以关闭或清除。
- PDF 下载是单独的服务器处理;你也可以选择本地打印或 MD/HTML 下载。
格式参考CommonMark 入门GitHub Flavored Markdown 规范
反馈可复现的问题请说明浏览器、所选设置,并附上不含隐私的最小示例。不要通过邮件发送私密文档。