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

VSCode怎么配置Asciidoctor编写高质量技术文档

梦敏大大_2552

梦敏大大_2552

发布时间:2026-05-22 17:05:06

|

306人浏览过

|

来源于php中文网

原创

VSCode需asciidoctor-vscode插件配合本地asciidoctor(Ruby)或asciidoctor.js才能正常渲染AsciiDoc;仅装插件不配处理器将导致预览简陋、宏/主题/PDF导出失效,须验证asciidoctor安装、配置路径、关闭插件样式干扰、修正相对路径、安装asciidoctor-pdf及中文字体主题。

vscode怎么配置asciidoctor编写高质量技术文档

VSCode 本身不支持 AsciiDoc 渲染,必须靠 asciidoctor-vscode 插件 + 本地 asciidoctor(Ruby)或 asciidoctor.js 处理器协同工作;只装插件不配处理器,预览会降级为简陋 HTML,宏、主题、PDF 导出等功能全部失效。

确认 asciidoctor 是否已安装并可用

插件默认尝试调用系统命令 asciidoctor,不是 Ruby gem 安装的,VSCode 就找不到它。常见错误是:右键“Open Preview”后空白、报错 command 'asciidoctor.preview' not found 或预览里看不到图片/样式。

  • 终端运行 asciidoctor -v,有输出说明已安装;没反应或提示 command not found,需先装 Ruby 再执行 gem install asciidoctor
  • macOS 用户若用 Homebrew 安装 Ruby(brew install ruby),注意检查 ~/.homebrew/bin 是否在 $PATH 中,否则 VSCode 终端能运行但 GUI 启动的 VSCode 找不到命令
  • Windows 用户推荐用 Ruby+DevKit 官方安装包,避免用 MSYS2 或 WSL 环境下的 Ruby,插件目前对跨子系统路径识别不稳定
  • 不想装 Ruby?可设 asciidoc.use_asciidoctor_js 为 true,但 asciidoctor.js 不支持 PDF 导出、部分扩展宏(如 include:: 相对路径在某些版本有 bug)

关闭插件自带样式干扰预览效果

默认预览套用插件内置 CSS,白底黑字、无字体控制、不加载文档中定义的 :stylesheet: 或主题,导致你写的样式全被覆盖——尤其是想用自定义主题导出 PDF 前,得先确保预览也接近终稿效果。

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • 打开设置(Cmd+, / Ctrl+,),搜索 asciidoctor.use_editor_style,**取消勾选**
  • 同时确认 asciidoctor.preview.refreshDelay 设为 500(防频繁重绘卡顿)
  • 重启 VSCode 或重开 .adoc 文件,再右键预览,此时会读取文档头部的 :stylesdir: 和 :stylesheet: 配置(如有)
  • 若仍不生效,检查文档开头是否有 :nofooter: 或 :notitle: 等属性干扰了样式加载逻辑

图片和 include 路径在预览中不显示?

VSCode 预览对相对路径解析不如命令行严格,尤其 include:: 和 image:: 常因工作区根目录与文件实际位置不一致而 404。这不是 bug,是插件按 VSCode URI 规则解析路径的结果。

  • image::./assets/diagram.png[] 在预览中失败?改用 image::assets/diagram.png[](去掉 ./)
  • include::sections/intro.adoc[] 报错?确保该文件在当前 .adoc 所在目录的 sections/ 子目录下,且 VSCode 工作区根目录就是该 .adoc 所在父目录
  • 更稳妥做法:在 VSCode 设置中配置 asciidoctor.asciidoctor_command 为完整路径,例如 /usr/local/bin/asciidoctor,让插件彻底走命令行流程,路径行为与终端一致
  • 临时调试:终端进到 .adoc 所在目录,手动运行 asciidoctor -d article -o preview.html doc.adoc,对比输出是否正常

导出 PDF 时中文乱码或样式丢失

这是最常被忽略的环节:VSCode 预览正常 ≠ PDF 正常。PDF 渲染由 asciidoctor-pdf 独立完成,它不读 VSCode 设置,只认 Ruby 环境、字体配置和主题文件。

  • 必须运行 gem install asciidoctor-pdf,且版本 ≥ 2.3.0(旧版对中文支持极差)
  • 下载 Noto Serif CJK 或思源宋体等 OpenType 字体,解压后在项目根目录建 fonts/ 文件夹,放入 .otf 文件
  • 创建 pdf-theme.yml,明确指定 font: {catalog: {Noto Serif CJK SC: {normal: fonts/NotoSerifCJKsc-Regular.otf}}},并在文档头加 :pdf-themesdir: ./ 和 :pdf-theme: mytheme
  • VSCode 插件导出 PDF 功能(右键菜单 “Export to PDF”)本质是调用 asciidoctor-pdf 命令,所以终端能跑通,插件才能导出成功

真正麻烦的从来不是装插件,而是让 VSCode、Ruby、asciidoctor、asciidoctor-pdf、字体、主题、路径这六者对齐同一套上下文。少一个环节,预览或导出就断在某个“看起来应该没问题”的地方。

热门AI工具

更多
SkildArt
SkildArt Hot

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

超级简历WonderCV

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

Loomy
Loomy Hot

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

豆包大模型

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

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

DeepSeek

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2709

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2128

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1120

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1058

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1276

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

1958

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3020

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

13115

2023.09.22

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

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

160

2026.09.23

热门下载

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

精品课程

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

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