Apache NetBeans Antora Wiki 项目教程

1、项目的目录结构及介绍

Apache NetBeans Antora Wiki 项目的目录结构如下：

netbeans-antora-wiki/
├── README.md
├── antora-playbook.yml
├── modules/
│   ├── ROOT/
│   │   ├── pages/
│   │   │   ├── index.adoc
│   │   │   └── ...
│   │   ├── partials/
│   │   │   └── ...
│   │   └── nav.adoc
│   └── ...
└── site/
    └── ...

• README.md: 项目介绍文件。
• antora-playbook.yml: Antora 配置文件，用于定义文档站点的基础配置。
• modules/: 包含所有文档模块的目录。
  • ROOT/: 根模块，包含项目的核心文档。
    • pages/: 存放文档页面的目录。
    • partials/: 存放可重用文档片段的目录。
    • nav.adoc: 导航文件，定义文档站点的导航结构。
• site/: 生成的静态站点文件存放目录。

2、项目的启动文件介绍

项目的启动文件主要是 antora-playbook.yml，它定义了如何构建和部署文档站点。以下是该文件的主要内容：

name: netbeans-antora-wiki
title: Apache NetBeans Antora Wiki
version: latest
start_page: ROOT:index.adoc
nav:
  - modules/ROOT/nav.adoc
asciidoc:
  attributes:
    revnumber: latest
url: https://example.com/netbeans-antora-wiki

• name: 项目名称。
• title: 文档站点标题。
• version: 文档版本。
• start_page: 启动页面，通常是首页。
• nav: 导航文件路径。
• asciidoc: AsciiDoc 配置。
• url: 生成的文档站点 URL。

3、项目的配置文件介绍

项目的配置文件主要是 antora-playbook.yml，它包含了构建文档站点所需的所有配置信息。以下是一些关键配置项的介绍：

• name: 定义项目的名称。
• title: 定义文档站点的标题。
• version: 定义文档的版本。
• start_page: 定义启动页面，即用户访问站点时首先看到的页面。
• nav: 定义导航文件的路径，导航文件定义了文档站点的导航结构。
• asciidoc: 定义 AsciiDoc 的相关配置，如文档属性等。
• url: 定义生成的文档站点的 URL。

通过这些配置项，可以灵活地定制和部署文档站点，满足不同的需求。