Antora 文档
技术作家的静态站点生成器
本网站提供 Antora 的技术文档。Antora 让技术撰稿人轻松创建文档并发布到网络上。作为技术撰稿人,您只需使用 Antora 的内容标记语言 AsciiDoc 撰写内容。您将这些文件整理成标准的项目结构,并将其存储在一个或多个内容(git)库中。Antora 从那里获取内容并将其转换为网站。仅此而已!
将文档作为代码进行管理
使用 Antora,您可以 像管理代码一样管理文档。这意味着您的文档流程将受益于成功软件的相同实践。
这些实践包括:
-
在版本控制系统中存储内容。
-
分离内容、配置和展示。
-
利用自动化进行编译、验证、核实和发布。
-
重复使用共享材料(DRY)。
Antora 可帮助您将这些做法纳入文档工作流程。因此,您的文档将更易于管理、维护和改进。
从哪里开始
如果您刚刚开始使用 Antora,您可能想知道 Antora 能如何帮助您。在熟悉了基本概念后,您可以使用 Antora 快速入门指南 试用 Antora。
如果您准备建立一个新的文档项目,或想将现有项目迁移到 Antora,请先将文档文件整理成 Antora 期望的 项目结构。然后,您需要 创建一个 playbook,告诉 Antora 在哪里可以找到您网站要使用的文档和用户界面。
如果你想尽快进入写作状态,那么请学习如何使用 AsciiDoc 语法来 创建文档页面。你可能会发现 IntelliJ AsciiDoc插件 是作者最好的朋友。它不仅可以帮助编写和预览 AsciiDoc 内容,还提供了最先进的工具来创建和验证 Antora 配置和资源引用。
如果您想深入了解网站生成器管道的细节,请查看 Antora 如何工作。
我们希望您在使用 Antora 制作文档网站的过程中感到愉快并有所收获。祝您写作愉快!