https://github.com/pelican-plugins/neighbors

Neighbors is a Pelican plugin that adds Next/Previous links to articles
https://github.com/pelican-plugins/neighbors

Last synced: 2 days ago
JSON representation

Neighbors is a Pelican plugin that adds Next/Previous links to articles

• Host: GitHub
• URL: https://github.com/pelican-plugins/neighbors
• Owner: pelican-plugins
• License: agpl-3.0
• Created: 2020-08-27T09:36:56.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T22:52:05.000Z (7 months ago)
• Last Synced: 2024-04-14T12:29:14.597Z (7 months ago)
• Language: Python
• Homepage:
• Size: 37.1 KB
• Stars: 11
• Watchers: 4
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-pelican - neighbors - neighbors)](https://pypi.org/project/pelican-neighbors/)| [pelican-plugins](https://github.com/pelican-plugins) | Neighbors is a Pelican plugin that adds Next/Previous links to articles (Plugins / Migrated to new architecture)

README

        
# Neighbor Articles: A Plugin for Pelican

[![Build Status](https://img.shields.io/github/workflow/status/pelican-plugins/neighbors/build)](https://github.com/pelican-plugins/neighbors/actions)

[![PyPI Version](https://img.shields.io/pypi/v/pelican-neighbors)](https://pypi.org/project/pelican-neighbors/)

Neighbors is a Pelican plugin that adds Next/Previous links to articles.

## Installation

This plugin can be installed via:

    python -m pip install pelican-neighbors

## Usage

This plugin adds a couple of new variables to the article's context:

* `next_article` (newer)

* `prev_article` (older)

* `next_article_in_category`

* `prev_article_in_category`

* `next_article_in_subcategory#`

* `prev_article_in_subcategory#`

Here is an example on how to add article navigation in your Jinja `article.html`

template:

```html+jinja



    {% if article.prev_article %}

        


            

                {{ article.prev_article.title }}

            

        

    {% endif %}

    {% if article.next_article %}

        


            

                {{ article.next_article.title }}

            

        

    {% endif %}





    {% if article.prev_article_in_category %}

        


            

                {{ article.prev_article_in_category.title }}

            

        

    {% endif %}

    {% if article.next_article_in_category %}

        


            

                {{ article.next_article_in_category.title }}

            

        

    {% endif %}



```


## More Categories plugin support

You can use the Neighbors plugin with the [More

Categories](https://github.com/pelican-plugins/more-categories) plugin.

Since an article can belong to more than one subcategory, subcategories are

stored in a list. If you have an article with subcategories like

`foo/bar/baz`, it will belong to both subcategory `bar` and `bar/baz`.

Subcategory neighbors are added to an article as `next_article_in_subcategory#`

and `prev_article_in_subcategory#`, where `#` is the level of subcategory.

Using the example above:

- `subcategory0` is `foo`

- `subcategory1` will be `foo/bar`

- `subcategory2` will be `foo/bar/baz`

## Subcategory plugin support

You can use the Neighbors plugin in conjunction with the [Subcategory

plugin](https://github.com/getpelican/pelican-plugins/tree/master/subcategory).

Since an article can belong to more than one subcategory, subcategories are

stored in a list. If you have an article with subcategories like

`Category/Foo/Bar`, it will belong to both subcategory `Foo`, and `Foo/Bar`.

Subcategory neighbors are added to an article as `next_article_in_subcategory#`

and `prev_article_in_subcategory#` where `#` is the level of subcategory. So

using the example from above, `subcategory1` will be `Foo`, and `subcategory2`

will be `Foo/Bar`.

## Template Examples

The usage with subcategories from either the Subcategory plugin or the More Categories plugin is:

```html+jinja



    {% if article.prev_article_in_subcategory1 %}

        


            

                {{ article.prev_article_in_subcategory1.title }}

            

        

    {% endif %}

    {% if article.next_article_in_subcategory1 %}

        


            

                {{ article.next_article_in_subcategory1.title }}

            

        

    {% endif %}





    {% if article.prev_article_in_subcategory2 %}

        


            

                {{ article.prev_article_in_subcategory2.title }}

            

        

    {% endif %}

    {% if article.next_article_in_subcategory2 %}

        


            

                {{ article.next_article_in_subcategory2.title }}

            

        

    {% endif %}



```


## Limitations

If an article has multiple categories, only the first category is considered.

## Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on [existing issues][].

To start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.

[existing issues]: https://github.com/pelican-plugins/neighbors/issues

[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html