显示源代码：Pelican插件

此Pelican插件允许您以与Sphinx相同的方式放置链接到您的文章源内容文件。它适用于页面和文章。

安装

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

python -m pip install pelican-show-source

有关更详细的插件安装说明，请参阅Pelican插件文档。

配置

要启用此插件，请确保您的设置文件中已设置SHOW_SOURCE_ON_SIDEBAR = True或SHOW_SOURCE_IN_SECTION = True。

SHOW_SOURCE_ALL_POSTS = True将显示所有文章的源代码，而不仅仅是明确提供源代码的文章（见下文）。默认值为False。

选项 SHOW_SOURCE_PRESERVE_EXTENSION （默认为 False）控制输出源文件的扩展名。如果设置为 True，文件将与真实源文档具有相同的扩展名（例如 .rst，.md 等）。否则，它将是一个纯文本的 .txt 文件。

为帖子提供源文件

为了标记帖子以便查看其源文件，请使用以下元数据字段（除非被覆盖）用于 reStructuredText 文档

:show_source: True

或者，对于 Markdown 语法

Show_source: True

插件会将您的源文档 URL 渲染为相应的 article.show_source_url（或 page.show_source_url）属性，然后可以在网站模板中访问该属性。

在模板中显示源代码

要使“显示源代码”链接在文章或页面上显示，您必须修改您的主题，无论是侧边栏显示还是文章底部。

文章或页面侧边栏显示

如何使用 pelican-bootstrap3 主题在侧边栏中显示源链接

{% if SHOW_SOURCE_ON_SIDEBAR %}
    {% if (article and article.show_source_url) or (page and page.show_source_url) %}
        <li class="list-group-item"><h4><i class="fa fa-tags fa-file-text"></i><span class="icon-label">This Page</span></h4>
            <ul class="list-group">
                <li class="list-group-item">
                    {% if article %}
                    <a href="{{ SITEURL }}/{{ article.show_source_url }}">Show source</a>
                    {% elif page %}
                    <a href="{{ SITEURL }}/{{ page.show_source_url }}">Show source</a>
                    {% endif %}
                </li>
            </ul>
        </li>
    {% endif %}
{% endif %}

文章底部显示

以下是一些代码（是的，又是 pelican-bootstrap3），用于在文章底部启用源链接

{% if SHOW_SOURCE_IN_SECTION %}
    {% if article and article.show_source_url %}
    <section class="well" id="show-source">
        <h4>This Page</h4>
        <ul>
            <a href="{{ SITEURL }}/{{ article.show_source_url }}">Show source</a>
        </ul>
    </section>
    {% endif %}
{% endif %}

覆盖默认插件行为

该插件的默认行为是逐个启用显示源代码。这可以通过在设置文件中使用 SHOW_SOURCE_ALL_POSTS = True 来更改。这意味着无论在元数据中是否设置了 show_source，插件都会发布所有源文档。

除非被覆盖，每个文档都保存为带有 .txt 扩展名的文章或页面别名属性。

例如，如果您的配置如下配置 ARTICLE_SAVE_AS

ARTICLE_SAVE_AS = "posts/{date:%Y}/{date:%m}/{slug}/index.html"

…您的静态 HTML 帖子和源文本文件将如下所示

posts/2016/10/welcome-to-my article/index.html
posts/2016/10/welcome-to-my article/welcome-to-my article.txt

您可以在设置文件中添加 SHOW_SOURCE_FILENAME 变量来覆盖源文件名，因此可以设置以下

SHOW_SOURCE_FILENAME = "my_source_file.txt"

因此，如果 ARTICLE_SAVE_AS 配置如下，文件将按如下方式保存

posts/2016/10/welcome-to-my article/index.html
posts/2016/10/welcome-to-my article/my_source_file.txt

页面的行为与此相同。

贡献

欢迎和高度赞赏贡献。每一份努力都很重要。您可以通过改进文档、添加缺失的功能和修复错误来贡献。您还可以通过审查和评论 现有问题 来帮助。

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

许可证

本项目采用 AGPL-3.0 许可证。