Markdown 是写文档、笔记和博客常用的轻量标记格式,用#写标题、-写列表、反引号写代码,很多静态网站还在文件开头用 front matter 写标题、日期等信息。整份直接转换,会把代码里的变量名、链接里的中文路径一起改掉,代码出错、链接失效。这个页面先识别 Markdown 的结构,只转换给人读的部分。
会转换的内容
- 正文、标题、列表、表格和引用。
- 链接文字和图片的 alt 文字。
- front matter 里的值。
- 指向标题的页内链接,跟着标题一起转换。
- 内嵌 HTML 标签里的 title、alt 等文字属性。
保持不变的内容
- 围栏代码块、缩进代码块和行内代码;代码块里的注释可选转换,默认不转。
- 链接和图片的地址,包括中文路径。
- front matter 的键名和 HTML 标签本身。
乱码与编辑器兼容
Markdown 编辑器和静态网站生成器通常按 UTF-8 读取文件。GBK 或 Big5 编码的旧文档会被自动识别并转成 UTF-8。换行符保持原样,BOM 默认跟随原文件,所以原文件是 UTF-8 时,用 Git 比较前后版本,差异只出现在转换过的文字上。
转换示例
| 原文 | 结果 |
|---|---|
| ## 安装说明 | ## 安裝說明 |
| 请先阅读[使用文档](docs/使用文档.md)。 | 請先閱讀[使用文檔](docs/使用文档.md)。 |
| 运行 `npm install 软件包` 安装依赖。 | 運行 `npm install 软件包` 安裝依賴。 |
|  |  |
| | 名称 | 说明 | | | 名稱 | 說明 | |
| - **注意**:后台程序会自动更新。 | - **注意**:後臺程序會自動更新。 |
由 OpenCC(s2t)实际转换生成。
怎么用
- 把 .md 或 .markdown 文件拖到页面上,或点「选择文件」,一组文档可以一次选多个。
- 选方向和标准;面向台湾读者的文档可以选「台湾」,「转换地区用词」默认打开,技术用语会换成台湾说法。
- 需要时展开「各格式的高级选项」,决定是否转换代码块里的注释。
- 核对预览后下载,多个文件可以点「全部下载(ZIP)」。
注意事项
- 转换地区用词时,技术词也会换成当地说法,例如「程序」转成「程式」、「文件」转成「檔案」。「文件」表示公文、书面材料时也会这样转,技术文档请通读一遍。
- 一简多繁的字单独出现时可能选错,文件里不会标注。没把握的段落可以粘贴到「文本」标签查看待确认字。
- 链接地址原样保留,例如 docs/使用文档.md。一组互相链接的文档,下载时文件名请选「保持原名」,否则加了语言后缀的文件名和链接对不上。
常见问题
代码块里的中文会被转换吗?
不会。围栏代码块、缩进代码块和行内代码都保持原样,变量名和字符串不受影响。代码块里的注释默认也不转,可以在高级选项里打开「Markdown:也转换代码块里的注释」。
目录里的页内链接还能用吗?
能。指向标题的页内链接会跟着标题一起转换,例如[安装](#安装)会变成[安裝](#安裝),和转换后的标题对得上。
front matter 会被改成什么样?
键名不变,只转换值,例如标题和摘要;值是路径或网址时保持原样。
文档里的 HTML 标签怎么处理?
标签本身保持不变,其中的 title、alt 等文字属性会转换。