可用和受支持的 Antora 组件
在本页中，您将看到可组合成自定义网站生成器管道的 Antora 组件列表。Antora 采用模块化架构，因此组件可以轻松拆卸和更换。通过其应用程序接口（API），您还可以集成 Asciidoctor 扩展程序。
核心组件
核心组件由网站生成器默认组件组装成管道。核心组件一起进行版本控制。
目前，只有版本相同的核心组件才能协同工作。例如，如果要在自定义网站生成器中使用内容分类器和页面合成器，请确保每个组件的版本相同。
如果您使用 CLI (@antora/cli) 和站点生成器 (@antora/site-generator)，那么您只需保持 CLI 和站点生成器的版本同步即可。如果您制作的是自定义网站生成器，则需要负责保持您使用的每个组件的同步。
扩展组件
扩展组件为特殊用例提供关键功能。扩展组件的一个例子是亚马逊 S3 存储桶的文件发布提供程序。扩展组件一旦准备 就绪，就会单独发布和版本控制。
支持的核心和扩展组件矩阵
| Name / Package | Description | Core | Extended | License |
|---|---|---|---|---|
AsciiDoc Loader |
用于在 Antora 中处理 AsciiDoc 内容的可重用库。它将 AsciiDoc 内容加载到 AsciiDoc 文档对象（AST）中。 |
✅ |
||
CLI |
Antora 的命令行界面 (CLI)。 |
✅ |
||
Content Aggregator |
抓取并聚合分布在多个本地和远程 git 仓库中的内容。 |
✅ |
||
Content Classifier |
将聚合的内容组织到虚拟文件目录中。 |
✅ |
||
Document Converter |
将 AsciiDoc 文档转换为可嵌入的 HTML。 |
✅ |
||
Logger |
为记录、调整和报告应用程序消息提供基础架构。 |
✅ |
||
Navigation Builder |
从导航文件建立导航目录。 该导航目录可用于为页面添加网站导航 |
✅ |
||
Page Composer |
将内容目录中每个页面文件的可嵌入 HTML 内容封装到 HTML 页面布局中。 这一步将在生成的网站中生成独立的 HTML 页面。 |
✅ |
||
Playbook Builder |
配置组件，用于根据用户输入构建 playbook 对象。 |
✅ |
||
Redirect Producer |
从已注册的别名生成指向指定页面的重定向（HTTP 重定向）。 |
✅ |
||
Site Generator |
Antora 的网站生成器。
由 Antora CLI 的 Renamed from @antora/site-generator-default. |
✅ |
||
Site Mapper |
生成网站的站点地图文件。 这些文件供爬虫读取，按 URL 列出所有已发布的页面。 |
✅ |
||
File Publisher |
将虚拟文件目录中的可发布文件发布（即写入）到 playbook 中指定的目标。 Renamed from @antora/site-publisher. |
✅ |
||
UI Loader |
下载并缓存 UI 包，然后从该包中提取文件并将其加载到 UI 目录中。 UI 文件与 Antora 文档管道末尾的内容文件相结合，生成完整的站点。 |
✅ |
||
Lunr Extension |
与 Lunr 集成的 Antora 扩展，可将 Lunr 支持的离线全文搜索添加到 Antora 文档站点。 |
✅ |