Asciidoctor 文档站点

欢迎来到 Asciidoctor 文档站点!在这里 您可以找到编写 AsciiDoc 内容并使用 Asciidoctor 发布它的参考资料、指南和示例。这些文档将帮助您开始 AsciiDoc 之旅,或者如果您已经走在路上,可以深入了解。

了解 AsciiDoc

AsciiDoc 是一种纯文本编写格式(即轻量级标记语言),用于编写技术内容,如文档、文章和书籍。如果您刚开始使用 AsciiDoc,或者想了解它的全部内容,请前往 AsciiDoc 语言文档。您将学到从如何创建第一个 AsciiDoc 文档到如何使用列表续接和定制替换等高级语言功能的所有知识。

如果您需要一个简洁的摘要,或者想一窥 AsciiDoc 的功能,请查看 语法快速参考。如果您想升级,还可以找到与 Markdown 并排的 比较

处理您的 AsciiDoc 内容

AsciiDoc 语言文档主要关于您为撰写文档而输入的源代码。一旦您完成写作并希望发布您的 AsciiDoc 文档,您将需要一个 AsciiDoc 处理器。这就是 Asciidoctor 发挥作用的地方。

Asciidoctor 是核心的 AsciiDoc 处理器。它读取 AsciiDoc 源,将其解析为文档模型,并使用转换器将其转换为可发布的格式,如 HTML。Asciidoctor 同时提供 CLIAPI,您可以使用它们来调用内置转换器(HTML、DocBook、man page)或附加转换器。Asciidoctor 通过应用 默认样式表、添加样式图标和 代码块语法高亮 来丰富其生成的 HTML。

选择一个处理器

核心 Asciidoctor 处理器有三个变体,它们共享相同的代码库。除少数例外,这些变体都提供完整的 Asciidoctor 体验。从这三种实现中,在 Asciidoctor 社区及其他地方延伸出了大量的扩展、构建工具集成和工具插件。选择最适合您所使用的语言平台的那一个。

Asciidoctor Ruby

原始代码库使您可以使用任何 Ruby 实现来运行 Asciidoctor,包括 C Ruby、JRuby 和 TruffleRuby。JRuby 和 TruffleRuby 允许您在 JVM 上使用 Asciidoctor。

Asciidoctor.js JavaScript

将 Asciidoctor 转译为 JavaScript,以便您可以在浏览器或 Node.js 应用程序中运行它。它提供了一个 CLI 和一个用于 Asciidoctor 文档模型中方法的易用 API,甚至允许您用 JavaScript 编写 Asciidoctor 扩展。

AsciidoctorJ Java/JVM

一个 Java 库,封装了 JRuby 的使用,以便在 JVM 上加载和运行 Asciidoctor。它提供了一个 CLI 和所有 Asciidoctor API 的原生 Java API 包装器,甚至允许您用 Java 编写 Asciidoctor 扩展。

探索 Asciidoctor

构建自动化

在运行构建时自动转换您的 AsciiDoc 内容。将资产、配置配置文件和扩展封装在您的构建脚本中,用于发布过程。甚至可以提取和转换 Javadoc 注释中的 AsciiDoc 或包含来自测试套件的片段。

扩展

用 AsciiDoc 编写 HTML 幻灯片演示文稿,而无需处理 HTML 的混乱,或者使用扩展将由纯文本标记生成的图表添加到输出文件中。可能性是无限的!

站点生成

想构建像这样的文档站点吗?用 AsciiDoc 编写站点内容。静态站点生成器委托给 AsciiDoc 处理器将 AsciiDoc 文件转换为嵌入式 HTML,然后将模板应用于该 HTML 以生成站点页面。

必备参考

将此用于编写和发布 AsciiDoc 和 Asciidoctor 内容的必备参考资料放在手边。

如何搜索文档

在任何页面上,您可以按 sCtrl+/ 来聚焦搜索框。输入一个或多个词(即查询)来搜索文档。或者,您可以按 Ctrl+< (即 US 键盘上的 Ctrl+Shift+,)来恢复之前的搜索。

当您键入查询时,搜索结果将显示在搜索框正下方的面板中。您可以使用鼠标或键盘浏览搜索结果列表并导航到结果。

要使用鼠标在当前选项卡中导航到结果,请将鼠标光标悬停在其上并使用鼠标左键单击。如果您想在查找最佳结果时保持搜索结果打开,可以将其在新选项卡中打开。要将结果在新选项卡中打开,请按住 Ctrl 单击结果,或右键单击它并选择“在新标签页中打开链接”。要清除搜索,请单击搜索结果面板外部的任意位置。

要使用键盘导航到结果,首先使用向上和向下箭头键选择一个结果。此操作将用浅蓝色选择框突出显示当前结果。然后,当结果突出显示时,按 Enter 在当前选项卡中导航到该结果。要在新选项卡中打开结果,请改按 Ctrl+Enter。要清除搜索,请按 Esc

搜索将使用模糊匹配来查找结果。这意味着它会找到与您输入的词或短语接近但又不完全相同的页面。此策略有助于弥合您的术语或措辞与文档中使用的情况之间的差距。如果您想查找精确匹配,请将查询用双引号括起来(例如,"the details of the syntax")。您还可以为单个词加上引号以禁用拼写错误容差(例如,"toc" position)。此策略可帮助您找到您要查找的内容,而不会产生误报。但是,它会产生较少的结果。另一种缩小结果范围的方法是在一个或多个词前面加上 -(例如,-document)。添加此前缀将排除包含该词的结果。

默认情况下,搜索会查找整个文档站点的结果。如果您想将搜索范围限制为您当前正在查看的项目版本文档,请勾选“在此项目中”复选框。您可以在搜索结果打开时切换此复选框,以比较整个站点和当前项目版本的结果。