站点地图

此Pelican插件可以生成纯文本或XML格式的站点地图。您可以在设置文件中使用SITEMAP变量来配置插件的行

安装

此插件可以通过以下方式安装

python -m pip install pelican-sitemap

用法

SITEMAP设置必须是一个Python字典，并且可以包含以下键

• format，它设置插件的输出格式（xml或txt）

• priorities，它是一个具有三个键的字典

  • articles，文章及其翻译的URL的优先级

  • pages，静态页面的URL的优先级

  • indexes，索引页面的URL的优先级，例如标签、作者页面、分类索引、存档等。

  此字典的所有值都必须是介于0和1之间的十进制数。

• changefreqs，这是一个包含三个条目的字典

  • articles，文章的更新频率

  • pages，页面的更新频率

  • indexes，索引页面的更新频率

  有效的频率值包括 always（始终）、hourly（每小时）、daily（每日）、weekly（每周）、monthly（每月）、yearly（每年）和 never（从不）。

• exclude，这是一个正则表达式列表，用于排除匹配的URL，如果其中任何一个匹配。例如

SITEMAP = {
    "exclude": [
        "^/noindex/",  # starts with "/noindex/"
        "/tag/",       # contains "/tag/"
        "\.json$",     # ends with ".json"
    ]
}

如果缺少键或值不正确，它将被默认值替换。

您也可以通过添加元数据来排除单个URL，将其 private 设置为 True。

站点地图保存为：<output_path>/sitemap.<format>

注意： priorities 和 changefreqs 是搜索引擎的信息，并且仅用于XML站点地图。有关更多信息，请参阅：https://www.sitemaps.org/protocol.html#xmlTagDefinitions

示例

以下是一个示例配置（也是默认设置）

SITEMAP = {
    "format": "xml",
    "priorities": {
        "articles": 0.5,
        "indexes": 0.5,
        "pages": 0.5
    },
    "changefreqs": {
        "articles": "monthly",
        "indexes": "daily",
        "pages": "monthly"
    }
}

贡献

欢迎并非常感谢贡献。每一份努力都很有帮助。您可以通过改进文档、添加缺失的功能和修复错误来做出贡献。您还可以通过审查和评论 现有问题 来提供帮助。

要开始为这个插件做出贡献，请参阅 向 Pelican 贡献 的文档，从 代码贡献 部分开始。

许可证

本项目采用 AGPL-3.0 许可。