邻近文章：Pelican 插件

Neighbors 是一个 Pelican 插件，它为文章添加了下一页/上一页链接。

安装

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

python -m pip install pelican-neighbors

用法

此插件向文章上下文添加了几个新变量

• next_article（较新）
• prev_article（较旧）
• next_article_in_category
• prev_article_in_category
• next_article_in_subcategory#
• prev_article_in_subcategory#

以下是如何在您的 Jinja article.html 模板中添加文章导航的示例

<ul>
    {% if article.prev_article %}
        <li>
            <a href="{{ SITEURL }}/{{ article.prev_article.url}}">
                {{ article.prev_article.title }}
            </a>
        </li>
    {% endif %}
    {% if article.next_article %}
        <li>
            <a href="{{ SITEURL }}/{{ article.next_article.url}}">
                {{ article.next_article.title }}
            </a>
        </li>
    {% endif %}
</ul>
<ul>
    {% if article.prev_article_in_category %}
        <li>
            <a href="{{ SITEURL }}/{{ article.prev_article_in_category.url}}">
                {{ article.prev_article_in_category.title }}
            </a>
        </li>
    {% endif %}
    {% if article.next_article_in_category %}
        <li>
            <a href="{{ SITEURL }}/{{ article.next_article_in_category.url}}">
                {{ article.next_article_in_category.title }}
            </a>
        </li>
    {% endif %}
</ul>

更多分类插件支持

您可以使用 Neighbors 插件与 More Categories 插件一起使用。

由于一篇文章可以属于多个子分类，因此子分类以列表形式存储。如果您有一篇具有子分类如 foo/bar/baz 的文章，它将属于子分类 bar 和 bar/baz。

子分类邻居以 next_article_in_subcategory# 和 prev_article_in_subcategory# 的形式添加到文章中，其中 # 是子分类的级别。

使用上述示例

• subcategory0 是 foo
• subcategory1 将是 foo/bar
• subcategory2 将是 foo/bar/baz

子分类插件支持

您可以将 Neighbors 插件与 Subcategory 插件 一起使用。

由于一篇文章可以属于多个子分类，因此子分类以列表形式存储。如果您有一篇具有子分类如 Category/Foo/Bar 的文章，它将属于子分类 Foo 和 Foo/Bar。

子分类邻居以 next_article_in_subcategory# 和 prev_article_in_subcategory# 的形式添加到文章中，其中 # 是子分类的级别。因此，使用上述示例，subcategory1 将是 Foo，而 subcategory2 将是 Foo/Bar。

模板示例

使用来自 Subcategory 插件或 More Categories 插件的子分类的用法

<ul>
    {% if article.prev_article_in_subcategory1 %}
        <li>
            <a href="{{ SITEURL }}/{{ article.prev_article_in_subcategory1.url}}">
                {{ article.prev_article_in_subcategory1.title }}
            </a>
        </li>
    {% endif %}
    {% if article.next_article_in_subcategory1 %}
        <li>
            <a href="{{ SITEURL }}/{{ article.next_article_in_subcategory1.url}}">
                {{ article.next_article_in_subcategory1.title }}
            </a>
        </li>
    {% endif %}
</ul>
<ul>
    {% if article.prev_article_in_subcategory2 %}
        <li>
            <a href="{{ SITEURL }}/{{ article.prev_article_in_subcategory2.url}}">
                {{ article.prev_article_in_subcategory2.title }}
            </a>
        </li>
    {% endif %}
    {% if article.next_article_in_subcategory2 %}
        <li>
            <a href="{{ SITEURL }}/{{ article.next_article_in_subcategory2.url}}">
                {{ article.next_article_in_subcategory2.title }}
            </a>
        </li>
    {% endif %}
</ul>

限制

如果一篇文章有多个分类，则只考虑第一个分类。

贡献

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

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