Skip to content
zhangxh edited this page Aug 16, 2026 · 5 revisions

TeXLeaf Wiki

TeXLeaf 是面向 VS Code 桌面版的 LaTeX 写作扩展,把三个彼此配合、又可以分别关闭的功能集中到一个插件中:

  1. 片段:212 条可编辑 Snippet、四个整篇 TeX 模板、数学输入辅助和结构化管理器;
  2. 文献:项目 bibliography 与 Zotero/Better BibTeX 联动的 VS Code 原生引用补全;
  3. 预览:离线 MathJax 4 SVG 活动公式预览。

本 Wiki 对应 TeXLeaf 0.7.1。扩展支持 Windows、macOS 和 Linux 上的 VS Code 1.98+,不依赖 Ultra Math Preview、Hyperscopes Booster 或在线 CDN,也不接管 LaTeX 编译流程。

安装

  1. 打开项目的 GitHub Releases
  2. 下载 texleaf-0.7.1.vsix
  3. 在 VS Code 运行 Extensions: Install from VSIX...
  4. 选择下载的 VSIX,并按提示重新加载窗口。

源码仓库只保存源码、测试、模板、文档和许可证。*.vsix、构建目录和其他二进制产物不会提交到源码分支;经过验证的 VSIX 只作为 GitHub Release 资产发布。详见 开发与发布

三分钟上手

片段

先把一个新文件保存为 .tex,然后尝试:

输入 结果
lm 自动展开为 \(...\)
dm 自动展开为缩进正确的 \[...\]
\thm 自动创建 theorem 环境
\dfn 自动创建 definition 环境
;a(数学区域) \alpha
//(数学区域) 带 tabstop 的 \frac{...}{...}

Ctrl+Shift+P / Cmd+Shift+P 运行 TeXLeaf: 管理 Snippet 与模板,可以搜索、添加、复制、修改、删除和批量替换 Snippet 或模板。完整说明见 片段与模板;自定义规则语法见 Snippet 格式

文献

  1. 在工作区中准备 reference.bib,或保留默认设置让 TeXLeaf 在首次导入时创建它。
  2. 启动 Zotero 桌面端;推荐安装与当前 Zotero 版本兼容的 Better BibTeX。
  3. 在 Zotero 设置中允许本机其他应用通信。
  4. 在已保存的 .tex 文件中输入 \cite{},把光标放在大括号内。

TeXLeaf 的原生 Suggest 条目左侧只显示标题和来源;选中后右侧按字段显示标题、作者、期刊/出版物、年份、Citation key、来源和收录/导入状态,不再在顶部重复一行“作者 · 期刊 · 年份”。可以用标题、作者、年份或 citation key 的任意部分筛选;同一个 \cite{...} 内可用逗号连续添加多篇文献。

连接、去重、BibTeX/BibLaTeX 和远程环境边界见 文献与 Zotero

预览

把光标移入 $...$\(...\)\[...\]$$...$$ 或常见数学环境。默认 cursor 模式会显示当前公式的圆角、不透明 SVG 预览:

  • 行内公式位于活动源码行下方,并随光标所在行移动;
  • 行间公式与 opening delimiter 对齐;
  • 深浅主题使用不同的高对比公式色和光标色;
  • 渲染在扩展自带的后台 Worker 中离线完成。

TeXLeaf 不提供 PDF 面板,也不把 VS Code 文本编辑器伪装成 Overleaf/Obsidian 式整篇所见即所得编辑器。原因和定位边界见 Math Preview

设置入口

在 VS Code Settings 中搜索:

@ext:local-lab.texleaf

用户可见设置严格分为三组:

  • TeXLeaf · 片段
  • TeXLeaf · 文献
  • TeXLeaf · 预览

全部 38 个设置、默认值、命令和快捷键见 配置参考

支持范围与重要边界

  • 编辑功能只在已保存的 .tex.bib 文件中运行;Untitled、.md 和其他后缀不会因为 language ID 看起来像 LaTeX 就自动展开。
  • Zotero 请求固定连接 127.0.0.1,不会连接任意远程主机,也不会访问 Zotero 云端账户。
  • 未信任工作区不会访问 Zotero 端口、创建 bibliography 或加载项目附加 Snippet 文件。
  • VS Code 会合并所有 Completion Provider。TeXLeaf 能控制自己的候选,但不能删除 LaTeX Workshop 等第三方扩展提供的 citation 候选;详见 文献与 Zotero#与-LaTeX-Workshop-及其他补全共存
  • Math Preview 是不改变文档内容的 decoration 浮层,不能给正文真正预留空间;超宽公式右端可能被编辑器裁切。
  • Settings Sync 由用户自行开启;它同步有效的 Profile 内部库,不等同于实时协作编辑,也不会自动在另一台机器安装手工分发的 VSIX。

文档导航

如需报告问题,请先阅读 故障排查,并附上 VS Code/TeXLeaf/Zotero/Better BibTeX 版本、操作系统、复现步骤,以及 Output → TeXLeaf 中与问题相关但已去除隐私的日志。

Clone this wiki locally