Skip to content

Sunrich-HT/ReadMap

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReadMap Logo

ReadMap

阅读不是囤积,是炼化。
知识不是碎片,是晶体。

Quick Start View Prompts Notion Setup Discussions

ReadMap Pipeline


Why ReadMap?

You read dozens of papers. You highlight, you annotate, you take notes.

But six months later:

  • Where did you file that paper on causal probing?
  • How does it relate to the new arXiv preprint you just opened?
  • What were the real weaknesses — not the authors' claims?
  • Which follow-up papers should you read next, and in what order?

Zotero stores. Obsidian links. Notion organizes. None of them connect.

ReadMap is the missing pipeline between papers and your brain.

3-Tier Reading System

The 3-Tier Reading System

Not every paper deserves 3 hours. ReadMap enforces a tiered investment strategy based on relevance:

Level Time When to use Output
⚡ Quick Scan 5 min Screening a new preprint Verdict + archive to Reading Queue
📖 Standard 30-45 min Worth learning from Cheat sheet + method table + Mermaid diagram + Notion sync
🔬 Deep Dive 2-3 h Core to your research Full 12-section document + Notion detail page + Wiki update

Deep Dive: The 12-Section Methodology

The soul of ReadMap. Every Deep Dive follows the same skeleton — no more blank-page syndrome:

  1. Paper Info & TL;DR
  2. Section-by-section reading along the paper's narrative
  3. Method & experiment teardown (tables + figure interpretation)
  4. Structure & logic flow (Mermaid pipeline + dependency diagrams)
  5. Field positioning & related work map (Mermaid landscape)
  6. Critical Lens (reproducibility / rigor / overclaim / boundaries)
  7. Reviewer Simulation (score + 3 weaknesses + rebuttal preview)
  8. Reproducibility & code assessment
  9. Aha Moments & Spotlight (transferable insights)
  10. Relation to my research (mapped to active projects)
  11. Extended reading suggestions (every entry must have a clickable link)
  12. One-Page Quick Reference (cheat card)

Standard covers sections 1, 3, 4, 10, 11, 12. Quick Scan covers section 1 only.

Two-Track Architecture

Content Notion Wiki (Quartz)
Full reading notes ✅ Warehouse
Cheat sheets ✅ Daily use ✅ Structured browsing
Knowledge maps / method genealogies ✅ Graph view + Mermaid
Concept definitions ✅ Detailed cards ✅ Knowledge graph
Methodology SOPs ✅ Editable ✅ Shareable

Notion is the warehouse. Wiki is the showroom.

Quick Start

# 1. Clone & install
git clone https://github.com/Sunrich-HT/readmap.git
cd readmap
python -m venv .venv && source .venv/bin/activate
pip install -e "."

# 2. Configure
cp .env.example .env
# Fill in your Notion token and database IDs

# 3. Download a paper
python -m readmap.fetch_paper https://arxiv.org/abs/2401.12345

# 4. Read with prompts, then sync to Notion
python -m readmap.sync_notion papers/2401.12345/deep-dive.md

See docs/notion-setup.md for step-by-step Notion database setup.

Project Structure

readmap/
├── prompts/                    # Core methodology assets
│   ├── quick-scan.md
│   ├── standard.md
│   ├── deep-dive.md            # 12-section structure
│   └── reviewer-simulation.md
├── src/readmap/                # Python package
│   ├── config.py               # Zero-hardcoded config
│   ├── markdown_parser.py      # Markdown → Notion blocks
│   ├── sync_notion.py          # Notion sync
│   ├── fetch_paper.py          # Download + MinerU parse
│   ├── build_wiki.py           # Wiki knowledge maps
│   └── pipeline.py             # Full orchestration
├── templates/                  # Output templates + Mermaid
├── wiki/                       # Quartz site template
└── docs/
    ├── notion-setup.md
    └── assets/                 # Logo, diagrams, divider

Notion Database Schema

ReadMap expects 4 databases. Property names are configurable — edit src/readmap/notion_client.py if you prefer English.

Database Key Properties
Literature 论文标题, 作者, 年份, 会议期刊, 精读模式, Reviewer评分, 速查卡, 主题
Reading Queue 论文标题, 来源, 状态, 链接, 推荐理由
Projects 项目名, 状态, 领域, 关联论文
Concept Cards 概念名, 一句话定义, 成熟度, 类型, 相关论文

Full schema + setup guide → docs/notion-setup.md

Share with the community

If ReadMap helps your research workflow, please consider sharing it. It really does help!

X LinkedIn Reddit

Development

# Optional: PDF parsing with MinerU
python -m venv .venv-mineru
source .venv-mineru/bin/activate
pip install mineru[all]

# Optional: Wiki site with Quartz
npm install -g quartz
npx quartz build --serve

Contribution

  • Add new prompt variations
  • Improve the Markdown → Notion parser
  • Share your reading templates
  • Discuss ideas in Discussions
  • Spread the word

路线图 / 待办

每篇论文都是矿石,ReadMap 是你的熔炉。
炼化流程可视化,知识结晶有迹可循。

ReadMap 知识炼化全流程

已落地 ✅

  • 三级精读体系(速扫 / Standard / Deep Dive)
  • 12 节精读方法论 SOP
  • Markdown → Notion 一键同步
  • Wiki 认知地图自动生成(Quartz)
  • MinerU 结构化 PDF 解析

正在炼化 🔄

  • 知识炼化流程可视化 — 将论文阅读→笔记→归档的完整链路做成交互式时间轴
  • 知识晶体成熟度面板 — 追踪每个概念的演进:🌱 种子 → 🌿 在长 → 🌳 成熟 → 💎 结晶
  • 论文关系图谱 2.0 — 自动提取引用关系,生成交互式引用网络图
  • 领域地图自动构建 — 基于阅读内容,AI 辅助生成 Mermaid 领域地图初稿

远景结晶 🔮

  • 个人知识图谱 3D 可视化 — 把 Notion + Wiki 的知识网络立体呈现
  • 阅读习惯量化分析 — 每月生成「阅读报告」:精读深度、领域分布、知识增长曲线
  • 跨论文概念溯源 — 追踪一个概念在多篇论文中的演变脉络
  • 知识晶体市场 — 分享你的精读模板和方法论,让知识流动起来

License

MIT

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors