{"id":19235586,"url":"https://github.com/renyuneyun/pelican-interrefs","last_synced_at":"2026-06-19T11:01:59.306Z","repository":{"id":47432590,"uuid":"516130974","full_name":"renyuneyun/pelican-interrefs","owner":"renyuneyun","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-13T16:42:06.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-02T13:54:27.611Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/renyuneyun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":"https://donate.getpelican.com","liberapay":"pelican"}},"created_at":"2022-07-20T20:50:50.000Z","updated_at":"2022-07-20T20:51:07.000Z","dependencies_parsed_at":"2022-08-28T16:51:30.282Z","dependency_job_id":null,"html_url":"https://github.com/renyuneyun/pelican-interrefs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/renyuneyun/pelican-interrefs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renyuneyun%2Fpelican-interrefs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renyuneyun%2Fpelican-interrefs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renyuneyun%2Fpelican-interrefs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renyuneyun%2Fpelican-interrefs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renyuneyun","download_url":"https://codeload.github.com/renyuneyun/pelican-interrefs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renyuneyun%2Fpelican-interrefs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34528144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-19T02:00:06.005Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T16:17:26.454Z","updated_at":"2026-06-19T11:01:59.277Z","avatar_url":"https://github.com/renyuneyun.png","language":"Python","funding_links":["https://donate.getpelican.com","https://liberapay.com/pelican"],"categories":[],"sub_categories":[],"readme":"Pelican Inter References: A Plugin for Pelican\n====================================================\n\n[![Build Status](https://img.shields.io/github/workflow/status/pelican-plugins/pelican-interrefs/build)](https://github.com/pelican-plugins/pelican-interrefs/actions)\n[![PyPI Version](https://img.shields.io/pypi/v/pelican-interrefs)](https://pypi.org/project/pelican-interrefs/)\n![License](https://img.shields.io/pypi/l/pelican-interrefs?color=blue)\n\nObtain inter-references (both forward and backward) of each article. The interrefs are links between articles on the same site (rather than arbitrary links on the Web).\n\nNote: Part of the information in this file is auto-generated. They may not work or correctly reflect the current status.\n\nInstallation\n------------\n\nThis plugin can be installed via:\n\n    python -m pip install pelican-interrefs\n\nUsage\n-----\n\nThis plugin adds a `interrefs` field to the article object, which contains two other fields: `forward` and `backward`.\n\nThe `interrefs.forward` field contains all (articles of) the forward links that present in this article (i.e. links to another article from this article). Similarly, the `interrefs.backward` field contains all (articles of) the backward links to this article (i.e. links from another article to this article).\n\nSpecifically, `interrefs` will evaluate to `False` if both `forward` and `backward` are empty. This should make the template simpler.\n\nThe following settings are recognized:\n\n- `FORWARD_REFS`: The number of forward links to have in the list\n- `BACKWARD_REFS`: The number of backward links to have in the list\n\nNote: The current implementation is not very efficient. The worst case complexity is `O(n^3)` where `n` is the number of articles.\n\n### Template\n\nYou may use this piece of code for your template.\n\n```\n{% if article.interrefs %}\n\u003cdiv class=\"interrefs\"\u003e\n    {% if article.interrefs.forward %}\n    \u003cdiv class=\"forward_refs\"\u003e\n        \u003cb\u003eForward links:\u003c/b\u003e\n        \u003cul\u003e\n        {% for post in article.interrefs.forward %}\n            \u003cli\u003e\u003ca href=\"{{ SITEURL }}/{{ post.url }}\"\u003e{{ post.title }}\u003c/a\u003e\u003c/li\u003e\n        {% endfor %}\n        \u003c/ul\u003e\n    \u003c/div\u003e\n    {% endif %}\n    {% if article.interrefs.backward %}\n    \u003cdiv class=\"backward_refs\"\u003e\n        \u003cb\u003eBackward links:\u003c/b\u003e\n        \u003cul\u003e\n        {% for post in article.interrefs.backward %}\n            \u003cli\u003e\u003ca href=\"{{ SITEURL }}/{{ post.url }}\"\u003e{{ post.title }}\u003c/a\u003e\u003c/li\u003e\n        {% endfor %}\n        \u003c/ul\u003e\n    \u003c/div\u003e\n    {% endif %}\n\u003c/div\u003e\n{% endif %}\n```\n\nTODO\n------------\n\n* [ ] Support posts?\n* [ ] Support i18n-subsites\n* [ ] Optimize performance\n\nContributing\n------------\n\nContributions 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][].\n\nTo start contributing to this plugin, review the [Contributing to Pelican][] documentation, beginning with the **Contributing Code** section.\n\n[existing issues]: https://github.com/pelican-plugins/pelican-interrefs/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n\nLicense\n-------\n\nThis project is licensed under the AGPL-3.0 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenyuneyun%2Fpelican-interrefs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenyuneyun%2Fpelican-interrefs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenyuneyun%2Fpelican-interrefs/lists"}