Asciidoctor Browser Extension 使用教程

Asciidoctor Browser Extension 使用教程

asciidoctor-browser-extension :white_circle: An extension for web browsers that converts AsciiDoc files to HTML using Asciidoctor.js. 项目地址: https://gitcode.com/gh_mirrors/as/asciidoctor-browser-extension

1. 项目介绍

Asciidoctor Browser Extension 是一个用于将 AsciiDoc 文件转换为 HTML 的浏览器扩展。它支持 Chrome、Brave、Firefox、Opera 和 Microsoft Edge 等主流浏览器。通过这个扩展，用户可以在浏览器中直接预览 AsciiDoc 文件，无需额外的工具或软件。

2. 项目快速启动

安装步骤

1. 下载扩展：

   • 访问 Asciidoctor Browser Extension 的 GitHub 页面。
   • 点击页面右上角的“Clone or download”按钮，选择“Download ZIP”下载项目压缩包。

2. 安装扩展：

   • 解压下载的 ZIP 文件。
   • 打开浏览器的扩展管理页面（例如 Chrome 浏览器中输入 chrome://extensions/）。
   • 启用“开发者模式”。
   • 点击“加载已解压的扩展程序”，选择解压后的文件夹。

3. 配置扩展：

   • 在扩展管理页面中找到 Asciidoctor Browser Extension，点击“详细信息”。
   • 启用“允许访问文件网址”。

使用示例

# 假设你有一个名为 example.adoc 的 AsciiDoc 文件
# 在浏览器中打开该文件
file:///path/to/your/example.adoc

3. 应用案例和最佳实践

应用案例

• 技术文档编写：开发人员可以使用 Asciidoctor 编写技术文档，并通过浏览器扩展实时预览文档效果。
• 博客文章编写：博客作者可以使用 AsciiDoc 编写文章，并通过扩展在浏览器中预览文章的 HTML 效果。

最佳实践

• 本地文件预览：确保扩展已启用“允许访问文件网址”，以便能够预览本地文件。
• 远程文件预览：可以直接在浏览器中打开远程的 AsciiDoc 文件进行预览。

4. 典型生态项目

• Asciidoctor：Asciidoctor 是一个快速文本处理器和发布工具链，用于将 AsciiDoc 文件转换为 HTML5、DocBook 和其他格式。
• Asciidoctor.js：Asciidoctor.js 是 Asciidoctor 的 JavaScript 实现，可以在浏览器或 Node.js 环境中运行。
• Asciidoctor PDF：用于将 AsciiDoc 文件转换为 PDF 格式的工具。

通过这些生态项目，用户可以更全面地管理和发布 AsciiDoc 文档。

asciidoctor-browser-extension :white_circle: An extension for web browsers that converts AsciiDoc files to HTML using Asciidoctor.js. 项目地址: https://gitcode.com/gh_mirrors/as/asciidoctor-browser-extension