讲师中心 微信公众号
AI工具推荐 视频效率加速

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

阿静姑娘_2414

阿静姑娘_2414

发布时间:2026-03-24 11:45:13

|

659人浏览过

|

来源于php中文网

原创

真正稳定可用的是 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 标签,比如 <details></details> 或 <div class="note"> 会被原样显示,这不是 bug,是设计使然<h3>用 Pandoc 导出 PDF 时字体中文全变成方块</h3> <p>根本原因是 Pandoc 默认调的 LaTeX 引擎(pdfTeX)压根不认系统中文字体。直接跑 <code>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\...)一起推上去。

    正确做法是全局忽略:

    • 在 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 代码块当普通代码看,靠注释写清意图,比如 <!-- seq: User -> Server: login --> ,真图交给专门的 Mermaid 编辑器(如 mermaid.live)补全
    • 硬上 JS 渲染?可以改 MarkdownLivePreview 的模板 HTML,但每次插件更新都会被覆盖,维护成本高,不推荐

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

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

相关专题

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

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

4616

2023.06.20

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

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

1395

2023.07.28

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

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

1818

2023.08.03

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

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

10183

2023.08.17

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

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

1000

2023.09.01

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

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

2904

2023.09.04

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

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

1609

2023.09.14

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

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

4969

2023.09.21

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn