Markdown Include：Pelican插件

此插件允许在Pelican文章中使用Markdown-Include扩展。

安装

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

python -m pip install pelican-markdown-include

只要您没有明确地将PLUGINS设置添加到您的Pelican设置文件中，则新安装的插件应该会自动检测并启用。否则，您必须将md_include添加到现有的PLUGINS列表中。有关更多信息，请参阅如何使用插件文档。

用法

在Pelican文章中使用语法为{!filename!}。根据Markdown-Include扩展的文档，此语句将被filename的内容替换，并且可以递归工作。替换是在任何其他Markdown处理之前完成的，因此可以在包含的文件中使用任何所需的Markdown语法。有关更多详细信息，请参阅Markdown-Include扩展文档。

配置

以下变量控制插件的行为，可以在Pelican设置文件中设置

• MD_INCLUDE_BASE_PATH：默认情况下，文件名是相对于Pelican运行目录给出的。可以通过此变量更改。

• MD_INCLUDE_ENCODING：包含文件的编码。默认："utf-8"

• MD_INCLUDE_INHERIT_HEADING_DEPTH：如果为True，则增加包含文件的标题深度。与下面的MD_HEADING_OFFSET选项结合使用。默认：False

• MD_HEADING_OFFSET：在MD_INCLUDE_INHERIT_HEADING_DEPTH选项的基础上增加特定数量的标题深度。默认：0

此插件的替代方案

Pelican允许通过在MARKDOWN配置变量中声明它们来使用额外的Markdown扩展。然而，如Pelican文档中所述，通过MARKDOWN设置添加新扩展是尴尬的，因为必须明确列出所有默认加载的扩展。除了避免此问题外，此插件还提供了一种“Pelican风格”的方法来设置Markdown-Include扩展的配置值（base_path、encoding、inherit_heading_depth和heading_offset）。此外，Markdown-Include扩展必须安装在一个Pelican可以找到的地方，这可能很棘手。

贡献

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

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

致谢

感谢Justin Mayer帮助将此插件迁移到Pelican Plugins组织。

作者

版权所有 © 2015, 2021-2024 Rafael Laboissière (rafael@laboissiere.net)

许可证

本项目采用AGPL-3.0许可协议。