建立一个标准页面

一个标准的页面有两个部分:页头和主体正文。

页头

页头是一组连续的行,从文件的第一行开始。头部封装了以下元素:

Example 1. Common elements in a page header
= Page Title (1)
:description: A description of the page stored in an HTML meta tag. (2)
:sectanchors: (3)
:url-repo: https://my-git-repo.com (4)
:page-tags: name of a tag, name of a tag (5)
1 在文件的第一行中输入的必需页面标题
2 可选的内置描述( description )元数据属性
3 可选的内置 AsciiDoc 属性
4 可选的自定义 AsciiDoc 属性
5 可选的自定义 Antora page- 属性

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

属性项,无论是内置的还是自定义的,都必须在各自的行中输入。标题还可以包含注释行。

页头以输入一个或多个空行结束。

主体正文

页头与主体之间至少有一个空行分隔。包含内容的下一行开始页面主体。

= Page Title
:description: A description of the page stored in an HTML meta tag.
:sectanchors:
:url-repo: https://my-git-repo.com
:page-tags: name of a tag, name of a tag
(1)
This is the first line of the page body. (2)

== Section heading

This is a paragraph in a section.
1 空白线结束页面标题。
2 在空白行之后,带有内容的下一行开始主体或页面。

页面主体的第一行可以是任何有效的 AsciiDoc 内容,如节标题、段落、表格、include 指令、图像等。

页面文件名

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

创建一个新的标准页面

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

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

    = The Title of My New Page
  3. 页面标题是唯一必需的标题元素。用一个空行将标题块与正文块分开。写你的内容。

    = The Title of My New Page
    
    Welcome to my new page!
  4. pages 目录中将文件保存为扩展名为 .adoc 。保存文件时使用的名称将用于计算页面的 URL 。

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

本例中创建的页面很简单。使用 AsciiDoc ,页头可以包含广泛的功能,页体可以处理复杂的内容。

记住要点

一个页面:

  • 是否存储在模块的 pages 目录中

  • 具有 .adoc 文件扩展

  • 具有仅包含符合 URL 字符的文件名

  • 具有一个小写的文件名(可选,但建议使用)

  • 有一个标题(即文档标题)

  • 使用有效的 Asciidoc 语法标记