0

0

使用VSCode编写和预览AsciiDoc与reStructuredText

P粉986688829

P粉986688829

发布时间:2025-12-18 20:05:02

|

959人浏览过

|

来源于php中文网

原创

在VSCode中实现AsciiDoc与reStructuredText实时预览需安装对应插件、配置处理器路径、关联文件类型并启用预览命令:先安装AsciiDoc和reStructuredText扩展,再分别配置Asciidoctor和docutils环境,最后设置文件关联与预览行为。

使用vscode编写和预览asciidoc与restructuredtext

如果您在VSCode中编写AsciiDoc或reStructuredText文档,但无法实时预览渲染效果,可能是由于缺少对应语言支持或预览插件未正确配置。以下是实现编写与预览功能的具体操作步骤:

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

一、安装核心扩展插件

VSCode本身不原生支持AsciiDoc和reStructuredText的语法高亮与预览,需依赖社区开发的扩展提供解析与渲染能力。安装适配度高、维护活跃的插件是启用功能的前提。

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

2、在扩展搜索框中输入AsciiDoc,找到由asciidoctor官方推荐的AsciiDoc by AsciiDoc VSCode Extension,点击安装。

3、再次搜索reStructuredText,选择由lextm发布的reStructuredText by LeXtudio并安装。

4、安装完成后,重启VSCode以确保语言服务器完全加载。

二、配置AsciiDoc预览行为

AsciiDoc插件默认启用侧边预览面板,但需确认是否启用实时刷新及是否绑定正确的Asciidoctor处理器路径。本地未安装Asciidoctor时,插件将回退至内置轻量解析器,部分宏与自定义属性可能不生效。

1、按下Cmd+,(macOS)打开设置界面,切换至“工作区”标签页。

2、在搜索框中输入asciidoc.preview.refreshDelay,将其值设为500(毫秒),以平衡响应速度与资源占用。

3、检查asciidoc.use_asciidoctor_js是否为true;若需完整特性支持,应设为false,并确保系统已通过gem安装asciidoctor:gem install asciidoctor

4、保存设置后,在任意.adoc文件中右键,选择“Open Preview to the Side”,即可启动双向同步预览。

三、启用reStructuredText实时HTML预览

reStructuredText插件依赖Python环境中的docutils库完成解析。预览功能基于本地生成临时HTML并调用VSCode内置Webview展示,不依赖外部浏览器进程。

1、确认系统已安装Python 3.8及以上版本,并在终端执行pip install docutils

Cutout.Pro
Cutout.Pro

AI驱动的视觉设计平台

下载

2、在VSCode中打开命令面板(Cmd+Shift+P),输入并选择reStructuredText: Preview

3、预览窗口首次加载较慢,因需初始化docutils解析器;后续编辑将触发自动刷新,延迟约1–2秒。

4、如需调整样式,可创建.rst同目录下的conf.py文件,配置html_theme = 'sphinx_rtd_theme'等选项(需额外安装sphinx)。

四、统一文件关联与默认格式识别

VSCode需明确将.adoc与.rst后缀关联至对应语言模式,否则无法触发语法高亮、代码片段及预览指令。手动设置可避免因文件名不规范导致的功能失效。

1、打开任意一个未识别的.adoc文件,点击右下角显示为“Plain Text”的语言模式按钮。

2、在弹出菜单中选择Configure File Association for '.adoc',然后选择AsciiDoc

3、对.rst文件重复相同操作,选择reStructuredText作为默认语言模式。

4、该设置将写入当前工作区的.vscode/settings.json,确保团队协作时格式一致性。

五、使用多光标与片段提升编写效率

两种标记语言均支持VSCode内置代码片段功能,配合多光标编辑可批量插入常用结构,减少重复输入。插件自带基础片段,亦支持用户自定义。

1、在AsciiDoc文件中输入sect2后按Tab,自动展开为二级章节模板,标题处进入可编辑状态。

2、在reStructuredText文件中输入section后按Tab,生成带下划线的章节标题行。

3、按住Option键(macOS)并点击多个位置,创建多个光标;输入相同内容(如角色引用:code:`xxx`)可一次性填充所有选中区域。

4、如需添加自定义片段,打开命令面板,输入并选择Preferences: Configure User Snippets,选择对应语言,按格式添加JSON条目。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

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

420

2023.08.07

json是什么
json是什么

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

536

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

339

2023.10.09

更新pip版本
更新pip版本

更新pip版本方法有使用pip自身更新、使用操作系统自带的包管理工具、使用python包管理工具、手动安装最新版本。想了解更多相关的内容,请阅读专题下面的文章。

416

2024.12.20

pip设置清华源
pip设置清华源

设置方法:1、打开终端或命令提示符窗口;2、运行“touch ~/.pip/pip.conf”命令创建一个名为pip的配置文件;3、打开pip.conf文件,然后添加“[global];index-url = https://pypi.tuna.tsinghua.edu.cn/simple”内容,这将把pip的镜像源设置为清华大学的镜像源;4、保存并关闭文件即可。

761

2024.12.23

python升级pip
python升级pip

本专题整合了python升级pip相关教程,阅读下面的文章了解更多详细内容。

349

2025.07.23

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

14

2026.01.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 3.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.3万人学习

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

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