Antora 文档

面向技术作者的静态站点生成器

该站点托管了 Antora 的技术文档。Antora 让技术作者能够轻松创建文档并将其发布到网络上。作为技术作者，您专注于使用 AsciiDoc，Antora 的内容标记语言来撰写内容。您将这些文件组织到一个标准的项目结构中，并将它们存储在一个或多个内容（git）存储库中。Antora 从那里获取您的内容并将其转换为网站。就是这么简单！

将文档视为代码管理

使用 Antora，您可以将 文档视为代码。这意味着您的文档流程受益于用于成功生成软件的相同实践。

其中一些实践包括：

  • 将内容存储在版本控制系统中。

  • 分离内容、配置和呈现。

  • 利用自动化进行编译、验证、验证和发布。

  • 重复使用共享材料（DRY）。

Antora 帮助您将这些实践纳入文档工作流程中。因此，您的文档更容易管理、维护和增强。

从哪里开始

如果您刚开始使用 Antora，您可能想了解 Antora 如何帮助您。当您熟悉基本概念后，您可以尝试使用 Antora 快速入门指南。

如果您准备设置一个新的文档项目，或者想要将现有项目迁移到 Antora，首先要将您的文档文件 组织到 Antora 期望的项目结构中。然后您需要 创建一个 playbook 来告诉 Antora 在哪里找到文档和用于您站点的用户界面。

如果您已经设置了文档组件，并且准备创建您的第一个站点，请检查您是否符合 Antora 的 系统要求，然后 安装 Antora，最后使用 antora 命令 生成您的站点。

如果您想开始撰写文档，请学习如何使用 AsciiDoc 语法 创建文档页面。您可能会发现 IntelliJ AsciiDoc 插件 是作者的好帮手。它不仅帮助编写和预览 AsciiDoc 内容，还提供了用于创建和验证 Antora 配置和资源引用的最先进工具。

如果您想深入了解站点生成器流程的细节，请查看 Antora 的工作原理。

我们希望您在使用 Antora 制作文档站点时愉快且有所收获。祝写作愉快！