paper-note-claude 1.0.0

package/bin/install.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const { execSync } = require('child_process');
+
+function detectPython() {
+  for (const cmd of ['python3', 'python']) {
+    try {
+      const version = execSync(`${cmd} --version 2>&1`, { encoding: 'utf8' }).trim();
+      if (/Python 3\.\d+/.test(version)) {
+        return { cmd, version };
+      }
+    } catch {}
+  }
+  return null;
+}
+
+function detectPip(pythonCmd) {
+  for (const cmd of [`${pythonCmd} -m pip`, 'pip3', 'pip']) {
+    try {
+      execSync(`${cmd} --version`, { stdio: 'ignore' });
+      return cmd;
+    } catch {}
+  }
+  return null;
+}
+
+console.log('Installing paper-note skill for Claude Code...\n');
+
+// 1. Copy skill files
+const destDir = path.join(os.homedir(), '.claude', 'commands');
+const srcDir = path.join(__dirname, '..', 'commands');
+fs.mkdirSync(destDir, { recursive: true });
+
+for (const file of ['paper_note.md', 'paper_note_step0.py']) {
+  fs.copyFileSync(path.join(srcDir, file), path.join(destDir, file));
+  console.log(`  copied: ${path.join(destDir, file)}`);
+}
+console.log();
+
+// 2. Check Python
+const python = detectPython();
+if (!python) {
+  console.log('Skill files installed, but Python 3 was not found.\n');
+  console.log('Please install Python 3 first:');
+  console.log('  https://www.python.org/downloads/\n');
+  console.log('Then run:');
+  console.log('  pip install pymupdf pymupdf4llm');
+  console.log('\nOnce done, open any folder in Claude Code and run:');
+  console.log('  /paper_note <path-to-pdf>');
+  process.exit(0);
+}
+
+console.log(`Found ${python.version}`);
+
+// 3. Check pip
+const pip = detectPip(python.cmd);
+if (!pip) {
+  console.log('pip not found. Please install pip and then run:');
+  console.log('  pip install pymupdf pymupdf4llm');
+  process.exit(0);
+}
+
+// 4. Install Python dependencies
+console.log('Installing Python dependencies...\n');
+try {
+  execSync(`${pip} install pymupdf pymupdf4llm`, { stdio: 'inherit' });
+  console.log('\nDone! Open any folder in Claude Code and run:');
+  console.log('  /paper_note <path-to-pdf>');
+} catch {
+  console.log('\npip install failed. Please run manually:');
+  console.log('  pip install pymupdf pymupdf4llm');
+}

package/commands/paper_note.md

@@ -0,0 +1,130 @@
+# 论文阅读笔记
+
+为 AI 领域论文自动生成结构化深度阅读笔记。
+
+## 用法
+
+```
+/paper_note <pdf路径> [输出路径]
+```
+
+## 依赖
+
+运行前需安装：
+
+```
+pip install pymupdf pymupdf4llm
+```
+
+---
+
+## 执行流程
+
+### Step 0：PDF 转文本
+
+运行：
+
+```
+python ~/.claude/commands/paper_note_step0.py <pdf_path> [output_dir]
+```
+
+- 若用户提供了输出路径，作为第二个参数传入
+- 否则脚本自动使用 `<pdf所在目录>/note/<title>/`
+
+解析返回的 JSON，得到 `title`、`fulltext_path`、`output_dir`。
+
+若返回 `error` 字段，报告错误并停止。
+
+读取 `fulltext_path` 中的全文 markdown，后续所有板块均基于此全文生成。
+
+---
+
+### Step 1：生成阅读笔记
+
+基于全文内容，按顺序生成以下 8 个板块，最终拼合写入 `<output_dir>/<safe_title>.md`。
+
+**通用约束：**
+
+- 板块一至板块六、板块八内容必须严格来自论文，不允许自由发散
+- 板块之间用 `\n---\n\n` 分隔
+- 每个板块末尾附来源标注：`<!-- src: fulltext.md -->`
+- 每个板块标题直接写内容标题，不加"板块X："前缀，例如：`# 论文核心信息`，而非 `# 板块一：论文核心信息`
+
+#### 板块一：论文核心信息
+
+从全文开头部分提取以下字段，以列表呈现：
+
+- 标题
+- 标题翻译（中文）
+- 作者
+- 机构
+- 发表时间
+- 发表期刊/会议
+- 代码仓库地址（仅从论文正文寻找，没有则留空）
+- 使用的数据集
+- 关键词
+
+#### 板块二：摘要翻译
+
+找到全文中的 Abstract 部分，完整翻译为中文，不添加额外内容。
+
+#### 板块三：创新点
+
+找到论文自述的 contribution 列表，逐条翻译为中文。
+
+#### 板块四：研究问题
+
+包含三个二级标题：
+
+- **论文要解决的问题**：从 Introduction 提炼实际问题或痛点
+- **现有方法为何不足**：从 Introduction 提炼现有方法局限
+- **问题的数学定义**：从 Preliminaries 或 Method 部分提取形式化定义，保留公式
+
+#### 板块五：方法
+
+找到 Method 相关章节。包含两个二级标题：
+
+- **建模思路简述**：最精简语言描述核心建模路线，目标 2 分钟能看懂
+- **方法部分全部公式**：列出所有公式，每条附一句必要说明
+
+#### 板块六：实验
+
+找到 Experiments 相关章节。每个实验生成一个二级标题，每个实验下包含四个三级标题：
+
+- **实验目的**
+- **实验设置**（数据集、基线、指标、关键超参数）
+- **实验结果**（文字描述结果，不插入图片）
+- **结论**
+
+#### 板块七：局限性与未来方向
+
+读取 Experiments 和 Conclusion 部分。**本板块允许自由发散。**
+
+每个观点标注来源：
+
+- 来自论文：句末注明 `（来自论文 conclusion/experiments）`
+- 自己发现：句末注明 `（来自 LLM 思考）`
+
+两类观点清晰区分，不得混写。
+
+#### 板块八：参考文献
+
+从全文末尾找到 References 部分，以列表形式列出所有引用文献：
+
+```
+- 标题 — 作者 et al. — 年份
+```
+
+严格照录，不添加摘要或评论。超过 3 位作者写"第一作者 et al."。
+
+---
+
+### Step 2：幻觉核查
+
+读取生成的笔记，对照 `fulltext.md` 核查：
+
+- **板块一至板块六、板块八**：发现与原文不符的内容直接修改或删除
+- **板块七**：仅核查标注 `（来自论文...）` 的观点，`（来自 LLM 思考）` 的观点不核查
+- **板块八专项**：逐条核查文献标题、作者、年份
+
+核查完成后覆盖写入最终笔记文件。

package/commands/paper_note_step0.py

@@ -0,0 +1,78 @@
+"""
+Step 0: PDF → Markdown 全文提取 + 标题识别
+用法: python src/step0_source.py <pdf_path> [output_dir]
+输出 JSON: {"title": "...", "fulltext_path": "...", "output_dir": "..."}
+"""
+
+import sys
+import json
+import re
+from pathlib import Path
+
+
+def sanitize_filename(name: str) -> str:
+    name = re.sub(r'[<>:"/\\|?*\n\r\t]', '', name)
+    return name.strip('. ')[:200] or "Untitled"
+
+
+def get_pdf_title(pdf_path: Path) -> str:
+    import fitz
+    doc = fitz.open(str(pdf_path))
+
+    title = doc.metadata.get("title", "").strip()
+    if title and len(title) > 5:
+        return title
+
+    page = doc[0]
+    blocks = page.get_text("dict")["blocks"]
+    max_size = 0
+    best_text = pdf_path.stem
+    for block in blocks:
+        if block.get("type") != 0:
+            continue
+        for line in block.get("lines", []):
+            for span in line.get("spans", []):
+                text = span["text"].strip()
+                if span["size"] > max_size and len(text) > 5:
+                    max_size = span["size"]
+                    best_text = text
+    return best_text
+
+
+def main(pdf_path: str, output_dir: str = None):
+    import pymupdf4llm
+
+    pdf = Path(pdf_path)
+    if not pdf.exists():
+        print(json.dumps({"error": f"PDF 文件不存在: {pdf_path}"}))
+        sys.exit(1)
+
+    print("[Step 0] 提取标题...", file=sys.stderr)
+    title = get_pdf_title(pdf)
+    safe_title = sanitize_filename(title)
+
+    if output_dir:
+        out_dir = Path(output_dir)
+    else:
+        out_dir = pdf.parent / "note" / safe_title
+    out_dir.mkdir(parents=True, exist_ok=True)
+
+    print("[Step 0] PDF 转 Markdown...", file=sys.stderr)
+    md_text = pymupdf4llm.to_markdown(str(pdf))
+    fulltext_path = out_dir / "fulltext.md"
+    fulltext_path.write_text(md_text, encoding="utf-8")
+
+    print("[Step 0] 完成", file=sys.stderr)
+    print(json.dumps({
+        "title": title,
+        "safe_title": safe_title,
+        "fulltext_path": str(fulltext_path),
+        "output_dir": str(out_dir),
+    }, ensure_ascii=False))
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("用法: python src/step0_source.py <pdf_path> [output_dir]")
+        sys.exit(1)
+    main(sys.argv[1], sys.argv[2] if len(sys.argv) > 2 else None)

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "paper-note-claude",
+  "version": "1.0.0",
+  "description": "Claude Code skill: generate structured reading notes for AI papers",
+  "bin": {
+    "paper-note-claude": "bin/install.js"
+  },
+  "files": [
+    "bin/",
+    "commands/"
+  ],
+  "keywords": [
+    "claude",
+    "claude-code",
+    "skill",
+    "slash-command",
+    "paper",
+    "research",
+    "notes",
+    "ai"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=14"
+  }
+}