基于Sublime Text的Asciidoctor技术文档编写

夏磊同学_1586

夏磊同学_1586

2026-07-06

487人浏览

原创

sublime text 中需手动安装 ruby 和 asciidoctor gem 并确保 path 正确,推荐终端启动 subl 继承环境变量;html 预览需指定样式或内联 css;中文文档须设 :lang: zh-cn 等属性;关闭自动构建更稳定,注意编码为 utf-8(无 bom)。

基于sublime text的asciidoctor技术文档编写

Sublime Text 里怎么让 asciidoctor 命令真正跑起来

默认安装完 Asciidoctor 插件,asciidoctor 命令找不到——根本原因是插件不自带 Ruby 环境和 asciidoctor gem,它只调用系统 PATH 里的可执行文件。

实操建议:

  • 先在终端运行 which asciidoctor,确认命令路径;如果返回空,说明没装或没加进 PATH
  • Mac 用户用 brew install ruby 后,再 gem install asciidoctor;Windows 用户推荐用 RubyInstaller(带 DevKit),然后 gem install asciidoctor
  • Sublime Text 启动方式影响 PATH:直接双击图标启动时,PATH 可能不含 shell 配置的路径;改用终端执行 subl 启动,才能继承 shell 的环境变量
  • 实在不行,可在插件配置里硬编码路径,比如 "asciidoctor_command": "/usr/local/bin/asciidoctor"

预览 HTML 时样式丢失或显示空白

Asciidoctor 默认输出纯 HTML,不带 CSS;插件调用 asciidoctor 时若没指定 backend 或 theme,浏览器打开后就是没样式的白页。

实操建议:

  • 确保文档开头有 :doctype: article 和 :stylesheet: ./css/default.css(路径需相对于当前 adoc 文件)
  • 更稳妥的做法是用 -a stylesheet= 参数强制内联样式:"asciidoctor_flags": ["-a", "stylesheet="],这样生成的 HTML 自带基础 CSS
  • 如果用了自定义主题(如 asciidoctor-pdf 或 asciidoctor-fopub),它们不参与 HTML 预览流程,别混淆 backend
  • 检查浏览器控制台是否报 Failed to load resource——大概率是 CSS 路径错或服务器没起本地服务(Sublime 插件默认用 file:// 协议,部分 CSS 特性会被禁用)

中文乱码、标点不换行、目录不生成

Asciidoctor 默认按英文排版习惯处理,中文文档会出三类典型问题:文字挤成一团、顿号逗号后不断行、toc::[] 不渲染。

Sublime Text Build Linux版
Sublime Text Build Linux版

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

下载

实操建议:

  • 必须加 :lang: zh-CN 和 :stem: latexmath(如需数学公式),否则中文字体 fallback 失败,且部分扩展(如 math)不激活
  • 启用自动断行:加 :text_align: justify + :hardbreaks:(慎用)或更推荐 :rouge-style: github(影响代码块,但间接改善整体排版流)
  • toc::[] 生效前提:文档要有至少两个 = 级标题,且插件配置里 "toc": true 开启;另外 :toc: macro 是旧写法,新版本推荐 :toc:(值为 left/right/preamble)
  • 导出 PDF 时中文仍乱码?那是 asciidoctor-pdf 的事,和 Sublime 插件无关;需单独配 pdf-theme 并指定 Noto Sans CJK 字体路径

保存即构建太频繁,或热重载不生效

很多插件提供 “on_save” 自动构建,但 Asciidoctor 解析成本不低,频繁触发反而卡住编辑器;而所谓“实时预览”,其实只是监听文件变化并 reload 浏览器,不是真正的热重载。

实操建议:

  • 关闭自动构建:"auto_build_on_save": false,改用手动快捷键(默认 Ctrl+Shift+A)更可控
  • 想接近实时效果?用 asciidoctor --watch 在终端单独起服务(需 asciidoctor-livereload gem),再配浏览器 LiveReload 插件;Sublime 插件本身不实现 WebSocket 通信
  • 注意文件编码:Sublime 默认用 UTF-8 with BOM 保存,而 asciidoctor 会报 invalid byte sequence in UTF-8;务必设为 UTF-8(无 BOM),菜单 → File → Save with Encoding → UTF-8
  • 修改了 .adoc 但预览没变?清浏览器缓存,或改用隐身窗口测试;部分插件生成的临时 HTML 文件名带时间戳,但浏览器可能仍缓存旧版本

最常被忽略的是环境隔离:系统 Ruby、rbenv、RVM、asdf 各自管理的 gem 目录互不相通,asciidoctor 装在哪,Sublime 就得用哪个。别在 zsh 里装好了就以为 GUI 应用能自动感知。

相关文章

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

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

下载

相关标签:

sublime text sublime

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

相关专题

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

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

2023.10.24

1368

7

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

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

2024.10.24

4867

11

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

60

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

20

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

20

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

20

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

20

19

热门下载

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

精品课程

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