AsciidocFX 使用教程

1. 项目介绍

AsciidocFX 是一个基于 JavaFX 的书籍和文档编辑器，旨在构建 PDF、Epub、Mobi 和 HTML 格式的书籍、文档和幻灯片。AsciidocFX 不仅是一个文档编辑器，还是一个完整的工具链，支持多种扩展和插件，如 PlantUML、Mermaid、MathJax 等。AsciidocFX 在 2015 年获得了 Duke's Choice Award，证明了其在开源社区中的重要地位和影响力。

2. 项目快速启动

2.1 安装 AsciidocFX

2.1.1 在 Linux 上安装

你可以通过 Deb 或 Rpm 安装器或通过归档文件安装 AsciidocFX。

# 下载并解压归档文件
$ tar -xvzf AsciidocFX_Linux.tar.gz
$ cd AsciidocFX/bin
$ ./AsciidocFX

2.1.2 在 Windows 上安装

下载可执行文件/安装程序并运行它。

# 下载并运行安装程序
$ AsciidocFX_Windows.exe

2.1.3 在 Mac 上安装

下载 .dmg 文件并运行它，或者使用 Homebrew 安装。

# 使用 Homebrew 安装
$ brew install --cask asciidocfx

2.2 创建第一个文档

启动 AsciidocFX 后，你可以通过以下步骤创建你的第一个文档：

1. 点击菜单中的 New > Document。
2. 输入文档标题和内容。
3. 保存文档并选择输出格式（如 PDF、HTML 等）。

= 我的第一个文档
作者姓名
:toc:

这是一个使用 AsciidocFX 创建的简单文档。

== 第一节

这里是文档的第一节内容。

3. 应用案例和最佳实践

3.1 创建技术书籍

AsciidocFX 非常适合用于创建技术书籍。你可以使用 Asciidoc 语法编写内容，并通过 AsciidocFX 生成 PDF、Epub 等格式的书籍。

= Java 8 编程指南
作者姓名
:toc:

本书介绍了 Java 8 的新特性和最佳实践。

== 第一章：Lambda 表达式

Lambda 表达式是 Java 8 引入的一个重要特性，它允许你以更简洁的方式编写代码。

3.2 制作幻灯片

AsciidocFX 支持使用 Reveal.js 制作幻灯片。你可以通过以下步骤创建幻灯片：

1. 点击菜单中的 New > Slide。
2. 输入幻灯片内容。
3. 保存并生成幻灯片。

= 我的幻灯片
作者姓名
:toc:

[.slide]
== 第一张幻灯片

这里是幻灯片的内容。

[.slide]
== 第二张幻灯片

这里是第二张幻灯片的内容。

4. 典型生态项目

4.1 Asciidoctor

Asciidoctor 是一个快速文本处理器和发布工具链，用于将 AsciiDoc 内容转换为 HTML5、PDF 和其他格式。AsciidocFX 基于 AsciidoctorJ，提供了更丰富的图形界面和扩展功能。

4.2 PlantUML

PlantUML 是一个开源项目，允许你使用简单的文本描述来创建 UML 图。AsciidocFX 内置了对 PlantUML 的支持，你可以直接在文档中插入 UML 图。

[plantuml, target="uml-example"]
----
abstract class AbstractList
abstract AbstractCollection
interface List
interface Collection
List <|-- AbstractList
Collection <|-- AbstractCollection
Collection <|- List
AbstractCollection <|- AbstractList
AbstractList <|-- ArrayList
class ArrayList {
    Object[] elementData
    size()
}
enum TimeUnit {
    DAYS
    HOURS
    MINUTES
}
annotation SuppressWarnings
----

4.3 MathJax

MathJax 是一个用于在浏览器中显示数学公式的开源 JavaScript 库。AsciidocFX 支持使用 MathJax 在文档中插入数学公式。

[latexmath, target="tex-formula"]
----
\begin{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xy
\end{align}
----

通过以上模块，你可以快速上手 AsciidocFX，并利用其强大的功能创建各种格式的文档和幻灯片。