{"id":7839011,"url":"https://github.com/pelican-plugins/neighbors","last_synced_at":"2025-10-06T01:28:39.430Z","repository":{"id":52223622,"uuid":"290735414","full_name":"pelican-plugins/neighbors","owner":"pelican-plugins","description":"Neighbors is a Pelican plugin that adds Next/Previous links to articles","archived":false,"fork":false,"pushed_at":"2024-11-02T08:21:32.000Z","size":37,"stargazers_count":14,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-24T23:59:37.343Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pelican-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://donate.getpelican.com","liberapay":"pelican"}},"created_at":"2020-08-27T09:36:56.000Z","updated_at":"2025-07-26T14:23:12.000Z","dependencies_parsed_at":"2024-06-21T19:07:10.656Z","dependency_job_id":"dc1ecc8d-6de5-41ae-8d03-8e8c1569ac58","html_url":"https://github.com/pelican-plugins/neighbors","commit_stats":{"total_commits":34,"total_committers":14,"mean_commits":"2.4285714285714284","dds":0.7352941176470589,"last_synced_commit":"60649ac6f3494d01a37b9c6d3d455f9dc2502d55"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/pelican-plugins/neighbors","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fneighbors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fneighbors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fneighbors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fneighbors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pelican-plugins","download_url":"https://codeload.github.com/pelican-plugins/neighbors/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pelican-plugins%2Fneighbors/sbom","scorecard":{"id":726822,"data":{"date":"2025-08-11","repo":{"name":"github.com/pelican-plugins/neighbors","commit":"c369e0f0382a5f9083cca73850aac6e2006a3038"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Code-Review","score":0,"reason":"Found 2/23 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/pelican-plugins/neighbors/main.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:30","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:32","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:68","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:70","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:93","Warn: pipCommand not pinned by hash: .github/workflows/main.yml:94","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/main.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU Affero General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact 1.2.0 not signed: https://api.github.com/repos/pelican-plugins/neighbors/releases/42423499","Warn: release artifact 1.1.0 not signed: https://api.github.com/repos/pelican-plugins/neighbors/releases/30331720","Warn: release artifact 1.2.0 does not have provenance: https://api.github.com/repos/pelican-plugins/neighbors/releases/42423499","Warn: release artifact 1.1.0 does not have provenance: https://api.github.com/repos/pelican-plugins/neighbors/releases/30331720"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T13:04:07.563Z","repository_id":52223622,"created_at":"2025-08-22T13:04:07.564Z","updated_at":"2025-08-22T13:04:07.564Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278547774,"owners_count":26004772,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"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-04-13T00:10:09.632Z","updated_at":"2025-10-06T01:28:39.401Z","avatar_url":"https://github.com/pelican-plugins.png","language":"Python","funding_links":["https://donate.getpelican.com","https://liberapay.com/pelican"],"categories":["Plugins"],"sub_categories":["Migrated to new architecture"],"readme":"# Neighbor Articles: A Plugin for Pelican\n\n[![Build Status](https://img.shields.io/github/workflow/status/pelican-plugins/neighbors/build)](https://github.com/pelican-plugins/neighbors/actions)\n[![PyPI Version](https://img.shields.io/pypi/v/pelican-neighbors)](https://pypi.org/project/pelican-neighbors/)\n\nNeighbors is a Pelican plugin that adds Next/Previous links to articles.\n\n\n## Installation\n\nThis plugin can be installed via:\n\n    python -m pip install pelican-neighbors\n\n\n## Usage\n\nThis plugin adds a couple of new variables to the article's context:\n\n* `next_article` (newer)\n* `prev_article` (older)\n* `next_article_in_category`\n* `prev_article_in_category`\n* `next_article_in_subcategory#`\n* `prev_article_in_subcategory#`\n\nHere is an example on how to add article navigation in your Jinja `article.html`\ntemplate:\n\n```html+jinja\n\u003cul\u003e\n    {% if article.prev_article %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.prev_article.url}}\"\u003e\n                {{ article.prev_article.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n    {% if article.next_article %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.next_article.url}}\"\u003e\n                {{ article.next_article.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n\u003c/ul\u003e\n\u003cul\u003e\n    {% if article.prev_article_in_category %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.prev_article_in_category.url}}\"\u003e\n                {{ article.prev_article_in_category.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n    {% if article.next_article_in_category %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.next_article_in_category.url}}\"\u003e\n                {{ article.next_article_in_category.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n\u003c/ul\u003e\n```\n\n## More Categories plugin support\n\nYou can use the Neighbors plugin with the [More\nCategories](https://github.com/pelican-plugins/more-categories) plugin.\n\nSince an article can belong to more than one subcategory, subcategories are\nstored in a list. If you have an article with subcategories like\n`foo/bar/baz`, it will belong to both subcategory `bar` and `bar/baz`.\n\nSubcategory neighbors are added to an article as `next_article_in_subcategory#`\nand `prev_article_in_subcategory#`, where `#` is the level of subcategory.\n\nUsing the example above:\n- `subcategory0` is `foo`\n- `subcategory1` will be `foo/bar`\n- `subcategory2` will be `foo/bar/baz`\n\n\n## Subcategory plugin support\n\nYou can use the Neighbors plugin in conjunction with the [Subcategory\nplugin](https://github.com/getpelican/pelican-plugins/tree/master/subcategory).\n\nSince an article can belong to more than one subcategory, subcategories are\nstored in a list. If you have an article with subcategories like\n`Category/Foo/Bar`, it will belong to both subcategory `Foo`, and `Foo/Bar`.\n\nSubcategory neighbors are added to an article as `next_article_in_subcategory#`\nand `prev_article_in_subcategory#` where `#` is the level of subcategory. So\nusing the example from above, `subcategory1` will be `Foo`, and `subcategory2`\nwill be `Foo/Bar`.\n\n\n## Template Examples\n\nThe usage with subcategories from either the Subcategory plugin or the More Categories plugin is:\n\n```html+jinja\n\u003cul\u003e\n    {% if article.prev_article_in_subcategory1 %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.prev_article_in_subcategory1.url}}\"\u003e\n                {{ article.prev_article_in_subcategory1.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n    {% if article.next_article_in_subcategory1 %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.next_article_in_subcategory1.url}}\"\u003e\n                {{ article.next_article_in_subcategory1.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n\u003c/ul\u003e\n\u003cul\u003e\n    {% if article.prev_article_in_subcategory2 %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.prev_article_in_subcategory2.url}}\"\u003e\n                {{ article.prev_article_in_subcategory2.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n    {% if article.next_article_in_subcategory2 %}\n        \u003cli\u003e\n            \u003ca href=\"{{ SITEURL }}/{{ article.next_article_in_subcategory2.url}}\"\u003e\n                {{ article.next_article_in_subcategory2.title }}\n            \u003c/a\u003e\n        \u003c/li\u003e\n    {% endif %}\n\u003c/ul\u003e\n```\n\n## Limitations\n\nIf an article has multiple categories, only the first category is considered.\n\n\n## Contributing\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/neighbors/issues\n[Contributing to Pelican]: https://docs.getpelican.com/en/latest/contribute.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fneighbors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpelican-plugins%2Fneighbors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpelican-plugins%2Fneighbors/lists"}