可用和支持的Antora组件

在这个页面上,您将找到可以组装成自定义站点生成器管道的Antora组件列表。Antora具有模块化架构,因此组件可以轻松移除和替换。由于其API,您还可以集成Asciidoctor扩展。

核心组件

核心组件由站点生成器默认组件组装成管道。核心组件一起进行版本控制。

目前,只有具有相同版本的核心组件才被设计为可以一起工作。例如,如果您想在自定义站点生成器中使用内容分类器和页面组合器,请确保每个组件具有相同的版本。

如果您使用CLI(@antora/cli)与站点生成器(@antora/site-generator),那么您只需保持CLI和站点生成器的版本同步。如果您制作自定义站点生成器,则需要负责保持您使用的每个单独组件同步。

扩展组件

扩展组件为特殊用例提供关键功能。扩展组件的一个示例是用于Amazon S3存储桶的文件发布提供程序。一旦准备好进行普遍可用性,扩展组件将被单独发布和进行版本控制。

支持的核心和扩展组件矩阵

名称 / 包 描述 核心 扩展 许可证

AsciiDoc 加载器
@antora/asciidoc-loader

用于处理Antora中AsciiDoc内容的可重用库。它将AsciiDoc内容加载到AsciiDoc文档对象(AST)中。

MPL-2.0

CLI
@antora/cli

Antora的命令行界面(CLI)。

MPL-2.0

内容聚合器
@antora/content-aggregator

从多个本地和远程git存储库中获取和聚合内容。

MPL-2.0

内容分类器
@antora/content-classifier

将聚合的内容组织成虚拟文件目录。

MPL-2.0

文档转换器
@antora/document-converter

将AsciiDoc文档转换为可嵌入的HTML。

MPL-2.0

日志记录器
@antora/logger

提供用于记录、整形和报告应用消息的基础设施。

MPL-2.0

导航构建器
@antora/navigation-builder

从导航文件中构建导航目录。此导航目录可用于向页面添加站点导航。

MPL-2.0

页面构建器
@antora/page-composer

将内容目录中每个页面文件的可嵌入HTML内容包装在HTML页面布局中。此步骤生成站点中的独立HTML页面。

MPL-2.0

Playbook 构建器
@antora/playbook-builder

从用户输入构建playbook对象的配置组件。

MPL-2.0

重定向生成器
@antora/redirect-producer

为给定页面从其注册的别名生成重定向(HTTP重定向)。

MPL-2.0

站点生成器
@antora/site-generator

Antora的站点生成器。由Antora的CLI的generate命令调用,用于生成和发布静态文档站点。此软件包将除CLI之外的所有其他非扩展软件包分组(即依赖于它们)。

从@antora/site-generator-default重命名。

MPL-2.0

站点映射器
@antora/site-mapper

为站点生成站点地图文件。这些文件旨在供网络爬虫阅读,提供按URL列出的所有已发布页面的列表。

MPL-2.0

文件发布器
@antora/file-publisher

将虚拟文件目录中的可发布文件发布(即写入)到playbook中指定的目标位置。

从@antora/site-publisher重命名。

MPL-2.0

UI 加载器
@antora/ui-loader

下载和缓存UI捆绑包,然后从该捆绑包中提取和加载文件到UI目录中。UI文件与内容文件合并在Antora文档管道的最后,以生成完整站点。

MPL-2.0

Lunr 扩展
@antora/lunr-extension

与Lunr集成的Antora扩展,通过Lunr提供离线全文搜索功能,为您的Antora文档站点提供支持。

MPL-2.0