设置标准页面

标准页面由标题和正文两部分组成。

页面标题是从文件的第一行开始的一组连续行。标题包含以下元素:

页面标题中的常见元素
= 页面标题 (1)
:description: 存储在HTML meta标签中的页面描述 (2)
:sectanchors: (3)
:url-repo: https://my-git-repo.com (4)
:page-tags: 标签名,标签名 (5)
1 必需的页面标题,输入在文件的第一行
2 可选的内置description元数据属性
3 可选的内置AsciiDoc属性
4 可选的自定义AsciiDoc属性
5 可选的自定义Antorapage-属性

页面标题必须使用Atx样式(单行)文档标题来定义,以单个等号开头。Antora不再支持AsciiDoc曾经支持的Setext样式(两行)文档标题语法。如果使用Setext样式语法,页面中的交叉引用将无法解析,并且AsciiDoc的其他功能将不可用。

无论是内置的还是自定义的属性条目,每个都必须单独输入在自己的一行上。标题还可以包含注释行

页面标题以输入一个或多个空行结束。

页面正文

页面标题与页面正文至少间隔一个空行。包含内容的下一行开始页面的正文。

= 页面标题
:description: 存储在HTML meta标签中的页面描述。
:sectanchors:
:url-repo: https://my-git-repo.com
:page-tags: 标签名,标签名
(1)
这是页面正文的第一行。(2)

== 章节标题

这是一个章节中的段落。
1 一个空行结束页面标题。
2 在空行之后,包含内容的下一行开始页面的正文。

页面正文的第一行可以是任何有效的AsciiDoc内容,如章节标题、段落、表格、包含指令、图片等。

页面文件名

页面存储在一个pages家族目录中。页面的文件名用于计算其URL。如果文件名以点(.)开头或没有文件扩展名结尾,Antora将忽略它。如果文件名以下划线(_)开头,它将被添加到内容目录中,但Antora不会发布它

创建一个新的标准页面

  1. 在您喜欢的IDE或纯文本编辑器中打开一个新文件。

  2. 在文件的第一行输入页面标题。页面标题由一个等号(=)指定,后跟一个空格,然后是标题的文本。

    = 我的新页面的标题
  3. 页面标题是唯一必需的标题元素。 通过一个空行将标题块与正文块分开。编写您的内容。

    = 我的新页面的标题
    
    欢迎来到我的新页面!
  4. 将文件保存为.adoc扩展名的文件,保存在pages目录中。保存文件时使用的名称将用于计算页面的URL。

您已经创建了一个标准页面!当您运行Antora时,它将被转换为HTML页面并自动发布到您的站点。

在此示例中创建的页面很简单。使用AsciiDoc,页面的标题可以包含各种功能,其正文可以处理复杂内容。

需要记住的关键点

一个页面:

  • 存储在模块的pages目录中

  • 具有.adoc文件扩展名

  • 文件名仅包含符合URL规范的字符

  • 文件名全小写(可选,但建议)

  • 具有标题(即,文档标题)

  • 使用有效的AsciiDoc语法标记