Atom 中的AsciiDoctor预览插件安装与配置指南

夏意杉Cub

于 2024-10-18 12:34:43 发布

阅读量1k

点赞数 24

本文链接：https://blog.youkuaiyun.com/gitblog_01258/article/details/143048478

版权

Atom 中的AsciiDoctor预览插件安装与配置指南

atom-asciidoc-preview ⚛ AsciiDoc preview for the Atom editor. 项目地址: https://gitcode.com/gh_mirrors/at/atom-asciidoc-preview

项目基础介绍及主要编程语言

AsciiDoctor Atom 预览 是一个专为Atom编辑器设计的插件，它允许用户实时预览AsciiDoc格式文档的渲染效果。此项目已经于2022年12月28日被维护者归档，但对那些仍在使用旧环境或有兴趣了解的开发者而言，以下信息依然有价值。项目主要使用 CoffeeScript 进行开发，辅以少量的 Less 和 HTML 代码。

关键技术和框架

Asciidoctor.js: 用于将AsciiDoc格式转换为HTML的JavaScript库。
Atom Editor: 开发环境，支持这款预览插件运行。
CoffeeScript: 编程语言，项目的主要实现基于此。
Key Bindings: 提供快捷键来切换预览，增强用户体验。

安装与配置步骤

准备工作

确保安装Atom: 首先，确保您已经安装了Atom编辑器。若未安装，请访问官方网站下载并安装适合您的操作系统版本。
Git: 需要安装Git，以便克隆插件的源码或者通过Atom的包管理器进行安装。

安装步骤

方法一：通过Atom包管理器

打开Atom编辑器。
转到 文件 > 设置（Mac上是 Atom > 首选项）。
点击安装标签页。
在搜索框中输入 asciidoc-preview。
找到 AsciiDoc Preview 插件，并点击 Install 进行安装。

方法二：手动安装（对于归档后的项目）

由于项目已经被归档，手动安装更多适用于查看或本地测试而非日常使用：

克隆仓库到本地：

git clone https://github.com/asciidoctor/atom-asciidoc-preview.git

打开命令行工具，进入刚刚克隆的目录。
使用Atom的包开发模式打开该目录（可以在Atom里通过 File > Preferences > Settings > Packages > 高级设置 > 开发包 来启用这个功能），或者在Atom中选择 Packages > Developer > Open Folder... 并指向刚才的目录。

配置步骤

激活插件: 安装后无需额外配置即可初步使用。但在Atom的设置界面中，你可以找到此插件的配置选项进行个性化调整。
快捷键绑定: 默认情况下，可以通过 ctrl-shift-a（Windows/Linux）或 cmd-shift-a（Mac）来切换预览窗口。
高级配置: 若要自定义如预览位置（左、右、上、下，默认为右）、是否开启TOC等选项，需访问 Atom菜单 > 首选项 > 包 ，找到 AsciiDoc Preview 插件并点击设置按钮。
样式定制: 若想改变预览的外观，可在设置中指定自己的CSS样式表路径。