scholarr/docs/index.md
Justin Visser 0c5b199b76 docs: rebuild documentation from scratch with clean IA
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-27 09:39:27 +01:00

1.2 KiB

title sidebar_position
Scholarr Documentation 1

Scholarr

Scholarr is a self-hosted academic publication tracker. It monitors Google Scholar profiles, discovers new publications, resolves open-access PDFs, and presents everything through a clean Vue 3 dashboard.

Section Description
User Guide What scholarr does, installation, configuration
Developer Guide Architecture, local development, contributing
Operations Deployment, database runbook, scrape safety
Reference API contract, environment variables, changelog

Key Features

  • Scholar Tracking - Add Google Scholar profiles by ID, URL, or name search
  • Automated Ingestion - Background scheduler fetches new publications on a configurable interval
  • Identifier Resolution - Cross-references arXiv, Crossref, and OpenAlex for DOIs and metadata
  • PDF Discovery - Resolves open-access PDFs via Unpaywall and arXiv
  • Import/Export - Portable scholar data with full publication state
  • Multi-User - Session-based auth with admin user management
  • Theming - Multiple color presets with light/dark mode support