AsciiDoc Preview 项目技术文档

AsciiDoc Preview 项目技术文档

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

安装指南

前提条件

• 确保你已经安装了 Atom 编辑器。
• 由于 GitHub 将于 2022 年 12 月 15 日停止支持 Atom，建议迁移到 IntelliJ 平台 或 Visual Studio Code。

安装步骤

1. 打开 Atom 编辑器。
2. 进入 Settings（设置） -> Install（安装）。
3. 在搜索框中输入 asciidoc-preview。
4. 点击 Install 按钮进行安装。

或者，你也可以通过命令行安装：

apm install asciidoc-preview

项目的使用说明

预览 AsciiDoc 内容

• 打开一个 .adoc, .asciidoc, .ad, .asc, .adoc.txt, .txt 文件。
• 使用快捷键 ctrl-shift-a 或 cmd-shift-a 打开预览窗格。
• 预览窗格将显示当前编辑器中 AsciiDoc 内容的渲染 HTML。

选项设置

• 实时预览或仅在保存时预览：在设置中选择预览模式。
• 预览窗格位置：选择预览窗格的位置（左、右、上、下）。
• 启用或禁用目录（TOC）：在预览窗格中显示或隐藏目录。
• 保存为 HTML：将文档保存为 HTML 文件。
• 导出为 PDF：创建 PDF 文件并使用默认 PDF 查看器打开。

注意事项

• 预览窗格的样式不旨在模拟发布样式，而是为了编辑时的内容预览。
• 如果需要自定义预览样式，可以在设置中指定自定义样式表。

项目 API 使用文档

基本 API

• 预览窗格切换：使用快捷键 ctrl-shift-a 或 cmd-shift-a 切换预览窗格。
• 实时预览：默认情况下，预览窗格会实时更新。
• 保存为 HTML：通过右键点击预览窗格，选择 Save as HTML 保存为 HTML 文件。
• 导出为 PDF：通过右键点击预览窗格，选择 Export as PDF 导出为 PDF 文件。

高级 API

• 自定义样式表：在设置中指定自定义 CSS 文件路径，以自定义预览窗格的样式。
• 同步预览窗格：启用同步功能后，预览窗格会与 AsciiDoc 源窗格同步滚动。

项目安装方式

通过 Atom 编辑器安装

1. 打开 Atom 编辑器。
2. 进入 Settings（设置） -> Install（安装）。
3. 在搜索框中输入 asciidoc-preview。
4. 点击 Install 按钮进行安装。

通过命令行安装

apm install asciidoc-preview

通过以上步骤，你可以轻松安装并使用 AsciiDoc Preview 插件，享受高效的 AsciiDoc 文档编辑和预览体验。

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