主题配置：Pelican插件

此软件包提供了一个Pelican静态网站生成器的插件，并为主题添加了对使用位于主题根目录中的themeconf.py文件调整Pelican配置的支持。

安装

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

python -m pip install pelican-theme-config

用法

将 theme_config 添加到 pelicanconf.py 文件中的插件列表中，例如：

PLUGINS = [ "theme_config" ]

从那时起，Pelican 将尝试从主题目录中加载 themeconf.py。

概述

此插件允许主题作者创建更自包含的主题，因为主题所需的一切都可以在主题本身中进行配置。

• 主题可以附带自己的插件
• 主题可以提供其静态内容（例如，实现 Google 的 PWA 的主题可以提供应该放入网站根目录的 manifest.json）
• 基本上，作者可以做几乎所有事情 :) 因为有了这个插件，主题获得了控制权

代码在 Pelican 启动序列的早期阶段就绪，利用 "initialized" Pelican 事件，因此几乎每个配置选项都可以安全地重新定义并生效。

然而，由于插件在 Pelican 对提供的配置完成检查之后连接，这提供了一些机会和风险。基本上，主题作者应该小心遵守 Pelican 的配置指令约定，否则可能会让用户困惑。

此插件保护以下配置选项免受主题修改：

• BIND
• CACHE_PATH
• PATH
• PELICAN_CLASS
• OUTPUT_PATH
• SITEURL
• THEME
• THEME_CONFIG
• THEME_CONFIG_PROTECTED
• PORT

如果用户想要进一步限制它或使其更宽松，可以在 pelicanconf.py 中配置此列表。目标是让用户能够定义其配置的预期行为。

该插件引入了以下可以在主要 Pelican 配置文件中指定的配置选项

# The name of the file to lookup in theme's directory
THEME_CONFIG = "themeconf.py"

# The list of configuration options to be protected from modification
THEME_CONFIG_PROTECTED = ["PATH","OUTPUT_PATH"]

贡献

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

要开始为此插件做出贡献，请查看 为 Pelican 贡献 文档，从 为代码做出贡献 部分开始。

鸣谢

由 Dmitry Khlebnikov 编写。