自动生成站点地图

如果playbook中定义的站点URL值是绝对URL,Antora将自动生成站点地图并将其输出到生成站点的根目录。

站点地图结构

Antora生成的站点地图由多个文件组成。Antora将站点地图分成多个文件,而不仅仅是一个单独的sitemap.xml文件。 sitemap.xml文件是一个站点地图索引,列出了每个单独组件站点地图文件。站点地图文件放置在发布站点的根目录下,搜索引擎会在那里查找它们。

404.html
index.html
robots.txt
sitemap.xml
sitemap-colorado.xml
sitemap-wyoming.xml
...

每个组件站点地图文件的命名为sitemap-<name>.xml,其中<name>是组件名称。该文件包含站点中每个可发布页面的<url>条目。站点地图中不包括其他类型的资源。

<url><loc>标签的值是该页面的绝对URL。 <url>值由站点URL(包括子路径)与页面的(相对根路径的)URL组合而成。 <url><lastmod>标签的值是生成站点的日期。

这些条目仅仅是为了确保顺序在运行之间保持稳定。

示例

让我们看一个示例。我们假设您的站点有两个组件,名称为colorado和wyoming,站点URL为https://docs.example.org。这是sitemap.xml的可能外观:

<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<sitemap>
<loc>https://docs.example.org/sitemap-colorado.xml</loc>
</sitemap>
<sitemap>
<loc>https://docs.example.org/sitemap-wyoming.xml</loc>
</sitemap>
</sitemapindex>

sitemap-colorado.xml的可能外观如下:

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.example.org/colorado/6.0/index.html</loc>
<lastmod>2021-12-24T23:00:00.123Z</lastmod>
</url>
...
</urlset>