zotero-addons-scraper/README.md
2026-04-12 12:59:26 +08:00

2.4 KiB

Zotero Addons Scraper

GitHub Build Status GitHub Last Commit Time jsdelivr hits

This is a script repository for scraping Zotero add-ons, intended for use with Zotero Addons.

Switch to addon-scraper source in Zotero Addons to use this repository.

Workflows

This repository utilizes GitHub Actions workflow for automation. including the following steps:

  • Retrieve Zotero add-on information specified in addons folder
  • Parse add-on information into JSON data
  • Publish the JSON data to the publish branch and the latest release
  • Validate changed addon tag metadata in CI

Contributing

Adding a new add-on entry {owner}@{repo} in the addons folder.

Optionally, add tags by writing JSON content to the file:

{"tags": ["reader"]}

Available tags:

Tag Description
ai AI-powered features (summarization, chat, translation via LLM)
metadata Metadata retrieval, citation counts, impact factor, formatting
reader PDF reading experience, annotation, highlighting
notes Note-taking, markdown export, knowledge management
attachment File management, attachment organization, OCR
interface UI enhancements, themes, column customization
integration Integration with external services (Notion, Obsidian, Word, etc.)
utility Zotero system tools (automation, deduplication, plugin management)

Tag validation in CI

  • pull_request on addons/**: validates changed addon files against the allowed tag taxonomy
  • push to master: validates changed addon files before the scraper publishes data
  • Each addon config must declare at least one tag, use only allowed tag values, avoid duplicates, and keep tags in canonical order

Usage

  1. fork this repository
  2. Enable actions and scheduled workflow in Actions page of forked repository