Sublime怎么写技术文档_Sublime如何搭建文档编写环境【指南】

阿静姑娘_2414

阿静姑娘_2414

2026-03-24

659人浏览

原创

真正稳定可用的是 MarkdownLivePreview 插件,安装后按 Ctrl+Alt+P 可实时预览,支持中文锚点跳转;导出 PDF 需用 xelatex 引擎并声明中文字体;.sublime-project 不应提交至 Git;Mermaid 图表需借助外部工具渲染。

sublime怎么写技术文档_sublime如何搭建文档编写环境【指南】

Sublime 里写 Markdown 文档,别装 Markdown Preview 插件

它早就不维护了,装上后 Ctrl+Shift+P 调不出预览,还可能和 mdpopups 冲突报错 ImportError: No module named 'mdpopups'。真正稳定可用的是 MarkdownLivePreview —— 它不依赖 Python 3.3+ 的旧运行时,也不改 Sublime 自带的渲染逻辑。

安装方式很简单:Ctrl+Shift+P → 输入 Package Control: Install Package → 搜 MarkdownLivePreview 回车。装完打开一个 .md 文件,按 Ctrl+Alt+P 就能唤出实时预览窗口。

  • 预览窗口默认用系统默认浏览器打开,不是内嵌窗;如需内嵌,得额外配 markdown_preview(但会重回兼容性坑)
  • 它对中文标题锚点支持正常,## 中文标题 点链接能跳转,不像某些插件生成 #%E4%B8%AD%E6%96%87 后乱码
  • 不解析 HTML 标签,比如
    或
    会被原样显示,这不是 bug,是设计使然

    用 Pandoc 导出 PDF 时字体中文全变成方块

    根本原因是 Pandoc 默认调的 LaTeX 引擎(pdfTeX)压根不认系统中文字体。直接跑 pandoc doc.md -o doc.pdf 必现方块,不是 Sublime 配置问题,是命令链路缺字体声明。

    解决办法是加一个 YAML 元数据头,在文档最开头插入:

    ---
    mainfont: "Noto Sans CJK SC"
    geometry: margin=1in
    ---

    然后用这个命令导出:

    pandoc doc.md -o doc.pdf --pdf-engine=xelatex
    • xelatex 才支持 TrueType 字体,pdflatex 不行
    • Noto Sans CJK SC 是 macOS / Linux 常见字体名,Windows 用户请换为 "Microsoft YaHei" 并确认系统已安装
    • 如果仍报 Font not found,用 fc-list :lang=zh 查看系统实际注册的中文字体名,注意空格和引号

    Sublime 自动保存 + Git 提交时,.sublime-project 该不该进仓库

    不该。这个文件存的是你本地的折叠状态、光标位置、已开标签页这些私人信息,一提交就容易和同事的编辑状态打架,git status 总飘红,还可能把临时路径(比如 C:\Users\Alice\...)一起推上去。

    讯飞智作-讯飞配音
    讯飞智作-讯飞配音

    讯飞智作-讯飞配音是一款由科大讯飞推出的 AI 配音和音视频内容生产工具。

    下载

    正确做法是全局忽略:

    • 在 Sublime 里打开 Preferences → Settings – User,加一行:"save_on_focus_lost": true,让编辑器自动保存,减少手动 Ctrl+S 需求
    • 在项目根目录的 .gitignore 里加:*.sublime-project 和 *.sublime-workspace
    • 如果已有误提交,运行:git rm --cached *.sublime-project *.sublime-workspace,再 commit

    想用 Sublime 写带 Mermaid 图表的文档,但预览不渲染

    因为 Mermaid 是 JavaScript 渲染的,而 MarkdownLivePreview 输出的是纯静态 HTML,没加载 Mermaid JS 库,也没初始化 mermaid.initialize()。不是插件不行,是它本来就没这功能。

    有两个务实选择:

    • 导出时处理:用 pandoc + mermaid-cli,先把 ```mermaid 块转成 PNG,再嵌入 PDF/HTML,适合最终交付
    • 编辑时妥协:在 Sublime 里把 Mermaid 代码块当普通代码看,靠注释写清意图,比如 ,真图交给专门的 Mermaid 编辑器(如 mermaid.live)补全
    • 硬上 JS 渲染?可以改 MarkdownLivePreview 的模板 HTML,但每次插件更新都会被覆盖,维护成本高,不推荐

    Mermaid 的语法校验和缩进敏感性,比 Markdown 本身还容易出错——一个漏掉的空行或错位的 indent,预览里就只剩白板。这点没法绕过去,只能边写边在 mermaid.live 里粘贴验证。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

sublime

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

2023.06.20

4636

8

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.07.28

1395

5

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1838

5

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

2023.08.17

10203

11

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1000

4

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

2904

5

Js中concat和push的区别
Js中concat和push的区别

Js中concat和push的区别:1、concat用于将两个或多个数组合并成一个新数组,并返回这个新数组,而push用于向数组的末尾添加一个或多个元素,并返回修改后的数组的新长度;2、concat不会修改原始数组,是创建新的数组,而push会修改原数组,将新元素添加到原数组的末尾等等。本专题为大家提供concat和push相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1609

5

js截取字符串的方法介绍
js截取字符串的方法介绍

JavaScript字符串截取方法,包括substring、slice、substr、charAt和split方法。这些方法可以根据具体需求,灵活地截取字符串的不同部分。在实际开发中,根据具体情况选择合适的方法进行字符串截取,能够提高代码的效率和可读性 。

2023.09.21

5009

3

js生成随机数方法
js生成随机数方法

JavaScript生成随机数的方法,包括使用Math.random()方法生成指定范围内的随机整数、生成随机字符串和生成随机颜色。根据具体需求,可以选择适合的方法来生成随机数,以实现各种功能 。

2023.09.25

2915

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程