AsciidocFX 项目教程

1. 项目目录结构及介绍

AsciidocFX 项目的目录结构如下：

AsciidocFX/
├── bin/
│   ├── AsciidocFX.bat
│   └── AsciidocFX.sh
├── conf/
│   ├── application.conf
│   └── logback.xml
├── lib/
│   └── (各种依赖库文件)
├── docs/
│   └── (项目文档)
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
└── target/
    └── (构建输出目录)

目录介绍

• bin/: 包含项目的启动脚本，AsciidocFX.bat 用于 Windows 系统，AsciidocFX.sh 用于 Linux 和 macOS 系统。
• conf/: 包含项目的配置文件，application.conf 是主要的配置文件，logback.xml 是日志配置文件。
• lib/: 包含项目依赖的所有库文件。
• docs/: 包含项目的文档文件。
• src/: 包含项目的源代码，分为 main/ 和 test/ 两个部分，分别存放主代码和测试代码。
• target/: 构建输出目录，包含编译后的文件和生成的文档。

2. 项目启动文件介绍

启动脚本

• AsciidocFX.bat: Windows 系统的启动脚本，双击即可启动 AsciidocFX。
• AsciidocFX.sh: Linux 和 macOS 系统的启动脚本，在终端中运行 ./AsciidocFX.sh 即可启动 AsciidocFX。

启动过程

1. 运行启动脚本。
2. 脚本会加载 conf/ 目录下的配置文件。
3. 启动 AsciidocFX 应用程序。

3. 项目配置文件介绍

application.conf

application.conf 是 AsciidocFX 的主要配置文件，包含以下配置项：

# 应用程序名称
app.name = "AsciidocFX"

# 日志配置
log.level = "INFO"
log.file = "asciidocfx.log"

# 其他配置项...

logback.xml

logback.xml 是日志配置文件，定义了日志的输出格式和级别：

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>${log.file}</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="${log.level}">
        <appender-ref ref="FILE" />
    </root>
</configuration>

配置项说明

• app.name: 应用程序的名称。
• log.level: 日志级别，可选值为 DEBUG, INFO, WARN, ERROR。
• log.file: 日志文件的路径。

通过修改这些配置文件，可以自定义 AsciidocFX 的行为和日志输出。