自动站点地图

如果 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> 标签的值是生成站点的日期。

为了确保在运行间保持稳定,这些条目仅是简单地排序。

示例

让我们来看一个例子。我们假设您的网站有两个组件,分别为 coloradowyoming ,而站点 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>