Pelican插件,用于生成纯文本或XML格式的站点地图
pelican-sitemap的Python项目详细描述
站点地图
此Pelican插件生成纯文本或XML格式的站点地图。您可以使用设置文件中的SITEMAP
变量来配置插件的行为。在
安装
此插件可以通过以下方式安装:
python -m pip install pelican-sitemap
使用
SITEMAP
设置必须是Python字典,并且可以包含以下键:
- 在
在format
,设置插件的输出格式(xml
或{}) - 在
priorities
,这是一个有三个键的字典:- 在
在articles
,文章及其翻译的url的优先级 - 在
在pages
,静态页的URL的优先级 - 在
在indexes
,索引页的URL的优先级,例如标记、作者页、类别索引、存档文件等
此字典的所有值必须是
在0
和1
之间的十进制数。在 - 在
- 在
changefreqs
,这是一个有三个项目的字典:- 在
在articles
,文章的更新频率 - 在
在pages
,页面的更新频率 - 在
在indexes
,索引页的更新频率
有效频率值为
在always
、hourly
、daily
、weekly
、monthly
、yearly
和{}。在 - 在
您可以通过正则表达式将URL排除在站点地图中。例如,要排除包含tag/
或category/
的所有url,可以使用以下SITEMAP
设置。在
如果缺少键或值不正确,将用默认值替换它。在
您还可以通过添加元数据来排除单个URL,将private
设置为True
。在
站点地图保存在:<output_path>/sitemap.<format>
Note:
priorities
andchangefreqs
are information for search engines and are only used in the XML site maps. For more information, see: https://www.sitemaps.org/protocol.html#xmlTagDefinitions
示例
以下是配置示例(也是默认设置):
# Where your plug-ins residePLUGIN_PATHS=["/where/you/cloned/it/pelican-plugins/",]PLUGINS=["sitemap",]SITEMAP={"format":"xml","priorities":{"articles":0.5,"indexes":0.5,"pages":0.5},"changefreqs":{"articles":"monthly","indexes":"daily","pages":"monthly"}}
贡献
我们欢迎并非常感谢您的贡献。每一点帮助。您可以通过改进文档、添加缺少的功能和修复错误来做出贡献。您也可以通过查看和评论existing issues来帮助您。在
要开始对此插件作出贡献,请查看Contributing to Pelican文档,从贡献代码部分开始。在
- 项目
标签: