0

0

VSCode的AsciiDoc:比Markdown更强大的文档编写语言

P粉986688829

P粉986688829

发布时间:2025-12-31 16:34:02

|

465人浏览过

|

来源于php中文网

原创

AsciiDoc是VSCode中比Markdown更强大严谨的轻量级标记语言,需安装asciidoctor.asciidoctor-vscode扩展、配置asciidoctor路径、用.adoc后缀和=标题启用预览、利用角色/块属性等语法增强表达,并通过Export导出PDF/EPUB。

vscode的asciidoc:比markdown更强大的文档编写语言

如果您希望在VSCode中使用一种比Markdown功能更丰富、结构更严谨的轻量级标记语言来编写技术文档,则AsciiDoc是一个值得深入使用的选项。以下是关于在VSCode中配置与使用AsciiDoc的具体说明:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装AsciiDoc扩展

VSCode本身不原生支持AsciiDoc渲染与预览,需通过官方推荐的扩展启用完整功能。该扩展提供语法高亮、实时预览、代码片段及导出能力。

1、打开VSCode,点击左侧活动栏的扩展图标(或按快捷键Ctrl+Shift+X)。

2、在搜索框中输入AsciiDoc,找到由asciidoctor.asciidoctor-vscode发布的扩展。

3、点击“安装”,安装完成后重启VSCode以激活全部功能。

二、配置AsciiDoc处理器路径

AsciiDoc扩展依赖本地AsciiDoc处理器(如Asciidoctor)执行解析与转换。若未配置可执行路径,预览将无法正常工作。

1、打开VSCode设置(Cmd+,),切换至“工作区”标签页。

2、在搜索框中输入asciidoctor.asciidoctorPath

3、点击“编辑 in settings.json”,在JSON中添加键值对:"asciidoctor.asciidoctorPath": "/usr/local/bin/asciidoctor"(路径需与实际安装位置一致)。

三、启用实时HTML预览

AsciiDoc扩展默认支持内联预览,但需确保文档保存为.adoc后缀且文件头包含有效文档声明,否则渲染可能不完整。

1、新建文件,保存为README.adoc

OpenGL入门教程 中文WORD版
OpenGL入门教程 中文WORD版

本文档是OpenGL入门教程;目的是让大家放弃TC的老旧图形接口,让大家接触一些新事物。OpenGL作为当前主流的图形API之一,它在一些场合具有比DirectX更优越的特性。OpenGL(全写Open Graphics Library)是指定义了一个跨编程语言、跨平台的编程接口规格的专业的图形程序接口。它用于三维图像(二维的亦可),是一个功能强大,调用方便的底层图形库。有需要的朋友可以下载看看

下载

2、在首行输入文档标题,格式为= 文档标题

3、按下Cmd+K V组合键,触发AsciiDoc预览面板,内容将以HTML形式动态渲染。

四、使用AsciiDoc特有语法增强表达力

相较于Markdown,AsciiDoc原生支持角色(role)、块属性(block attributes)、条件包含(ifdef)、自定义样式等高级特性,适用于复杂文档结构。

1、为段落添加CSS类:在段落前插入[.highlight]#这是高亮段落#

2、插入带编号的代码块:在代码块上方添加[source,rust,linenums],随后换行输入代码。

3、创建多级目录:在文档顶部添加:toc: left:toclevels: 3,保存后预览自动显示导航侧边栏。

五、导出为PDF或EPUB格式

AsciiDoc扩展集成了Asciidoctor工具链,可直接调用命令行工具生成高质量出版级输出,无需离开编辑器。

1、确保系统已安装asciidoctor-pdf:在终端执行gem install asciidoctor-pdf

2、右键点击.adoc文件编辑区域,选择AsciiDoc: Export Document As...

3、从弹出菜单中选择PDF,导出文件将保存在当前项目根目录下。

相关专题

更多
C++系统编程内存管理_C++系统编程怎么与Rust竞争内存安全
C++系统编程内存管理_C++系统编程怎么与Rust竞争内存安全

C++系统编程中的内存管理是指 对程序运行时内存的申请、使用和释放进行精细控制的机制,涵盖了栈、堆、静态区等不同区域,开发者需要通过new/delete、智能指针或内存池等方式管理动态内存,以避免内存泄漏、野指针等问题,确保程序高效稳定运行。它核心在于开发者对低层内存有完全控制权,带来灵活性,但也伴随高责任,是C++性能优化的关键。

9

2025.12.22

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

403

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

500

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

261

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

731

2023.07.28

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

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

共14课时 | 0.7万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.7万人学习

CSS教程
CSS教程

共754课时 | 17.2万人学习

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

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号