基于Sublime Text与AsciiDoc的标准化技术文档编写与编译发布

云明大大_4267

云明大大_4267

2026-08-31

556人浏览

原创

asciidocplus插件装错会导致.adoc文件显示为plain text、语法不高亮;必须确认sublime版本并安装匹配插件(text 4用asciidoctor-sublimetext版),手动切换右下角语法为asciidocplus,关闭asciidoctor_js回退并配置本地asciidoctor路径。

基于sublime text与asciidoc的标准化技术文档编写与编译发布

AsciiDocPlus 插件装不对,.adoc 文件永远是 Plain Text

Sublime 里打开 .adoc 文件显示为灰色、加粗语法 **text** 不高亮、右下角语法名是 Plain Text——基本就是插件没装对。不是“没装”,而是装了错的或版本不匹配的。

关键点有三个:

  • Sublime Text 4 必须用 AsciiDocPlus(作者名是 asciidoctor-sublimetext),不能选同名但作者为 msarhan 的旧版 AsciiDoc
  • 确认 Sublime 版本:Help → About Sublime Text,顶部明确写 Sublime Text 4 才能用新插件;若显示 Sublime Text 3,则必须用旧哈希值脚本安装 Package Control,否则 Ctrl+Shift+P 无效
  • 装完插件后,必须手动切换语法:右下角点击当前语法名 → 选 AsciiDocPlus;如果点开列表里没有它,说明插件根本没加载成功,重启 Sublime 后再试

预览失效?大概率掉进了 asciidoctor_js 回退陷阱

点 Ctrl+Shift+P → AsciiDoc: Preview,浏览器弹出 HTML,但 :icons: font 不显示、include:: 内容为空、自定义 docinfo 完全没渲染——这不是插件 bug,是默认启用了阉割版的 asciidoctor_js 引擎。

真功能必须走本地 asciidoctor CLI:

  • 先关回退:Preferences → Package Settings → AsciiDocPlus → Settings,把 "use_asciidoctor_js": true 改成 false
  • 再装 Ruby 版本:macOS/Linux 执行 gem install asciidoctor;Windows 用 choco install asciidoctorj(注意非 asciidoctor)
  • 最后配路径:Settings 里填 "asciidoctor_path",例如 macOS 是 /usr/local/bin/asciidoctor,Windows 是 C: oolssciidoctorjinsciidoctorj.bat
  • 改完设置务必重启 Sublime,否则仍走 JS 路径

LaTeXTools 编译失败,别怪插件,先查 latexmk 在不在 PATH

Ctrl+B 没反应、控制台报 command not found: latexmk,问题不在 Sublime,而在系统命令链断了。LaTeXTools 只是调用器,它不会自带编译器。

Sublime Text Build Linux版
Sublime Text Build Linux版

Sublime Text Linux x86-64 deb 安装包。官方也提供 rpm、tar.xz 和软件源安装方式。

下载

验证三步缺一不可:

  • 终端执行 which latexmk(macOS/Linux)或 where latexmk(Windows),必须返回有效路径
  • 执行 xelatex --version,确认引擎可用;若报错,说明 TeX 发行版没装全或没加进 PATH
  • 检查 echo $PATH(macOS/Linux)或 echo %PATH%(Windows),确认上一步返回的路径确实在其中
  • 任一失败,重装发行版:Mac 用户 brew install --cask mactex;Windows 用户重装 MiKTeX 并勾选「Add to PATH」;Linux 用户补装 sudo apt install latexmk texlive-latex-recommended

装完必须重启 Sublime,否则它读不到新 PATH。

tex_path 写死比 use_simple_detection 更可靠

很多人在 LaTeXTools 设置里留着 "use_simple_detection": true,指望插件自动找 latexmk,结果在 MacTeX 路径含空格(如 /Library/TeX/texbin)、或多版本 TeX Live 共存时 100% 失效。

直接写死路径最稳:

  • Preferences → Package Settings → LaTeXTools → Settings – User,删掉所有 use_simple_detection 字段
  • 填入明确路径:"tex_path": "/Library/TeX/texbin"(macOS)、"tex_path": "C:\texlive\2023\bin\win32"(Windows,注意双反斜杠)、"tex_path": "/usr/local/texlive/2023/bin/x86_64-linux"(Linux)
  • 同时设 "builder": "latexmk",并加 "cmd" 项强制用 XeLaTeX:"-pdfxe" 和 "-synctex=1"

路径里的年份(如 2023)必须和你实际安装的 TeX Live 版本一致,错一位就找不到命令。

相关文章

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

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

下载

相关标签:

sublime sublime text

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

相关专题

更多
常见的编码方式
常见的编码方式

常见的编码方式有ASCII编码、Unicode编码、UTF-8编码、UTF-16编码、GBK编码等。想了解更多编码方式相关内容,可以阅读本专题下面的文章。

2023.10.24

1468

7

a和A对应的ASCII码数值
a和A对应的ASCII码数值

a的ascii码是65,a的ascii码是97;ascii码表中,一个字母的大小写数值相差32,一般知道大写字母的ascii码数值,其对应的小写字母的ascii码数值就算出来了,是大写字母的ascii码数值“+32”。想了解更多相关的内容,可阅读本专题下面的相关文章。

2024.10.24

5327

11

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

2026.10.21

20

15

Playwright 页面操作指南
Playwright 页面操作指南

Playwright页面操作专题汇集元素定位、点击与输入、等待响应、多页面切换、Iframe、事件监听及文件处理的已审核文章,便于按操作场景查阅示例与常见问题。

2026.10.21

0

16

Playwright 入门教程
Playwright 入门教程

Playwright入门专题汇集测试框架安装、VS Code配置、录制脚本、编写首个用例、运行调试及查看报告的已审核文章,帮助初学者搭建端到端测试流程。

2026.10.21

0

16

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

120

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

80

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

60

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

40

15

热门下载

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

精品课程

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