mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 17:00:23 +00:00

Research Assistant 97a2875d48 docs: reset documentation IA (readme entry pages, tutorial/troubleshooting split, AGENTS agent-only, pure command ref, maintainer guide)

Separate audiences: README as navigation entry, getting-started as canonical tutorial,
troubleshooting as failure recovery, AGENTS as agent-only operating contract,
COMMANDS as pure reference, maintainer-guide for release/versioning/architecture.

2026-05-16 22:47:00 +08:00

4.3 KiB

Raw Blame History

PaperForge

简体中文 · English

铸知识为器，启洞见之明。 — Forge Knowledge, Empower Insight.

PaperForge brings your Zotero library into Obsidian. Sync papers, run OCR, extract figures, and do AI-assisted deep reading — all inside a single vault.

0. What PaperForge Is

PaperForge is not just an Obsidian plugin. It has two parts:

Part	What	Does	Where
Obsidian Plugin	`main.js` + `manifest.json` + `styles.css`	Dashboard, buttons, settings UI	`.obsidian/plugins/paperforge/` in your vault
Python Package	`paperforge`	Sync, OCR, Doctor, repair	Your system Python (`pip install`)

The plugin is the interface. The Python package is the engine. Every button you click in the plugin actually runs a Python command behind the scenes.

After installing the plugin, you MUST verify that the Python package is also installed and version-matched.

1. Install the Obsidian Plugin

Option A: Community Plugin Browser (Recommended)

Open Obsidian → Settings → Community plugins → Browse
Search for PaperForge
Click Install, then Enable

Community plugins auto-update through Obsidian. No extra steps needed.

Option B: BRAT

If you need beta versions or the plugin hasn't appeared in search yet:

Install BRAT from the Obsidian community plugin browser
Open BRAT settings → Add Beta Plugin
Enter: https://github.com/LLLin000/PaperForge
Enable PaperForge in Settings → Community Plugins

Option C: Manual Download

Go to Releases
Download the three files: main.js, manifest.json, styles.css
Create .obsidian/plugins/paperforge/ in your vault
Put the three files there
Restart Obsidian → Settings → Community Plugins → enable PaperForge

Manual install does not auto-update. You'll need to re-download for each new version.

2. Install the Python Package

After enabling the plugin, open the PaperForge settings tab. You'll see a Runtime Status section:

Plugin v1.5.0 → Python Package v1.5.0 ✓ Matched

If it says "Not installed" → click Open Wizard to re-run the setup process
If it says "Mismatch" → the Python package auto-updates when the plugin updates. If it didn't succeed, click Update Runtime to manually trigger

3. Quickstart

# 1. Export from Zotero (Better BibTeX JSON, Keep updated) to exports/
# 2. Sync
paperforge sync

# 3. Mark a paper for OCR in its frontmatter: do_ocr: true
# 4. Run OCR
paperforge ocr

# 5. Mark for deep reading: analyze: true
# 6. In your Agent chat:
/pf-deep <zotero_key>

文档导航

你想做什么	去看
完整教程，从安装到精读	使用教程
遇到问题了	故障排除
查某个命令	命令参考
如何升级	更新指南
架构 / 维护 / 发布	架构文档
AI Agent 协作	AGENTS.md

License

CC BY-NC-SA 4.0. Non-commercial use only.

Acknowledgments

Built on PaddleOCR, Obsidian, Better BibTeX for Zotero, and other great open-source projects.

4.3 KiB Raw Blame History