Re:Mark

浏览器书签同步与 AI 富化工具

一个基于原生浏览器书签的知识库：用 GitHub Gist 跨浏览器同步书签，并用 AI 为书签生成摘要、标签和封面，提供一个简洁的 Web 端浏览体验。

---

✨ 特性

• 📚 原生书签优先 - 以浏览器自带的书签管理为核心，不额外绑架数据格式，保持与原生书签一致
• 🔄 跨浏览器同步 - 使用 GitHub Gist 在 Chrome / Firefox / Edge 间无缝同步
• 🤖 AI 智能富化 - 自动提取摘要、标签、封面，让书签更易管理和检索
• 🌐 简洁 Web 界面 - 提供清爽的 Web 端浏览体验，随时随地查看你的书签
• 🔒 数据自托管 - Token 在本地，书签存储在你自己的 Gist，完全掌控数据安全

---

🚀 快速开始

浏览器扩展

安装扩展

1. Chrome 网上应用店（推荐）

   • 直接访问 Chrome 网上应用店 - Re:Mark 点击「添加至 Chrome」
   • 安装后在扩展的设置页填写配置（见下方配置说明）
   • 应用商店会自动推送更新，无需手动重新加载

2. 手动加载 / 开发模式

   • 用于 Edge / Firefox，或需要调试最新版。可在 Releases 下载打包产物，或在 extension 目录运行 bun install && bun run build 生成 extension/.output/。

   • Chrome / Edge

     1. 访问 chrome://extensions/（Edge 访问 edge://extensions/）
     2. 打开右上角的「开发者模式」
     3. 点击「加载已解压的扩展程序」
     4. 选择 extension/.output/chrome-mv3 目录

   • Firefox

     1. 运行 bun run build:firefox 构建
     2. 访问 about:debugging#/runtime/this-firefox
     3. 点击「临时加载附加组件」
     4. 选择 extension/.output/firefox-mv3/manifest.json

3. 配置扩展

   • 在扩展设置中填写 GitHub Token（需要 gist 权限）
   • Gist ID 可留空，扩展会自动创建
   • AI 相关的 API Secret / Web URL 可按需填写

4. 打包扩展（可选）

   • 如需生成 .crx 或 .xpi 文件，可在浏览器扩展页使用「打包扩展程序」功能

---

Web 端

方式一：Vercel 部署（推荐）

Vercel 提供免费的托管服务，非常适合部署本项目的 Web 端。

步骤：

1. Fork 本仓库

   • 点击 GitHub 页面右上角的 Fork 按钮，将仓库 Fork 到你自己的账号

2. 导入到 Vercel

   • 登录 Vercel
   • 点击 Add New... → Project
   • 选择 Import Git Repository
   • 从列表中选择你刚刚 Fork 的 remark 仓库

3. 配置项目

   • Root Directory: 在配置页面中，点击 Edit 修改 Root Directory 为 web
   • Environment Variables: 点击「Environment Variables」部分，添加以下环境变量

4. 添加环境变量

   完整参考 web/.env.example 文件，逐项填入环境变量：

   # GitHub Gist 配置
   GITHUB_TOKEN=your_github_token_here
   GIST_ID=your_gist_id_here
   
   # AI API 配置（根据需要选择）
   AI_API_KEY=your_ai_api_key_here
   AI_API_URL=your_ai_api_url_here

5. 部署

   • 点击 Deploy 按钮，等待部署完成
   • 部署成功后，访问 Vercel 提供的域名即可查看你的书签库

6. 配置 AI 富化（可选）

   • 如需使用 AI 富化功能，请确保已正确配置相关 API Key

方式二：本地部署

如果你想在本地运行 Web 端：

cd web
bun install
bun run dev

访问 http://localhost:3000 即可查看。

---

📄 开源协议

本项目采用 MIT License 开源协议。

---

📮 反馈与贡献

如果你在使用过程中遇到任何问题，或有任何建议和想法，欢迎：

• 提交 Issue
• 提交 Pull Request

---

如果这个项目对你有帮助，欢迎 Star ⭐️

Made with ❤️