Skip to content

AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.

docs: document web clipper MVP

yomae1ffe22011a5
diff --git a/README.md b/README.md
index 2bab8f37..e30332e3 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,7 @@ The automated helper commands are recommended. If you create the Cloudflare reso
- Batch note moving, notebook drag sorting, and hierarchy editing.
- Offline drafts and local sync queue for existing notes.
- Single-user login with PBKDF2-SHA256 password hashing.
+- Chrome/Edge web clipper MVP: extract the current article or selected content and save it to a self-hosted EdgeEver instance.
## PWA Installation
@@ -69,6 +70,20 @@ EdgeEver can be installed as a PWA on desktop or mobile home screens. On desktop
> Common pitfall: When installing the PWA on mobile, Chrome or Edge is recommended. Other mobile browsers may encounter compatibility issues or unexpected errors during installation.
+## Chrome/Edge Web Clipper
+
+The repository includes a Manifest V3 extension in `apps/extension` for Chrome and Microsoft Edge. It lets users configure their own EdgeEver instance and API Token, then save the selected content or the current article as a searchable memo.
+
+The current MVP extracts article content in the browser with Mozilla Readability and converts it to Markdown with Turndown. It does not yet preserve a complete single-file HTML archive or upload page resources to R2.
+
+Build the extension from the repository root:
+
+```sh
+bun run build:extension
+```
+
+Then load `apps/extension/dist` as an unpacked extension from `chrome://extensions` or `edge://extensions` with developer mode enabled. The API Token should have `read:notebooks` and `write:memos` scopes.
+
## Native Clients
Native clients are part of the EdgeEver roadmap. The mobile app is planned to be built with React Native, and the desktop app is planned to be built with Tauri.
@@ -81,6 +96,7 @@ The goal is to let users connect these clients to their own self-hosted EdgeEver
- Official site: Astro static site in `apps/site`, deployable to Cloudflare Pages.
- Frontend: Vite, React, React Router, TanStack Query, Tailwind CSS, shadcn/ui, and Radix UI.
- Editor: TipTap / ProseMirror with Markdown support; PWA uses vite-plugin-pwa, Workbox, and Dexie.
+- Web clipper: Manifest V3, Mozilla Readability, and Turndown for Chrome and Microsoft Edge.
- Backend: Cloudflare Workers, Hono, Zod, D1, and R2, with REST API, OpenAPI, and Remote MCP.
## Quick Start
@@ -114,6 +130,7 @@ bun run build
```text
apps/web Vite + React frontend, PWA, offline drafts, and sync queue
+apps/extension Chrome/Edge Manifest V3 web clipper
apps/api Cloudflare Worker + Hono API, OpenAPI, MCP endpoint
apps/mobile Expo + React Native mobile app
apps/site Astro official website, deployable independently
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 5068863a..66363cc3 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -64,6 +64,7 @@ Agent 应优先按 [AI Agent Cloudflare Deployment](docs/agent-deploy-cloudflare
- 多选移动笔记,笔记本支持拖拽排序和调整层级。
- 已有笔记支持离线编辑草稿和本地同步队列。
- 单用户登录,密码使用 PBKDF2-SHA256 hash。
+- 支持 Chrome/Edge 网页裁剪 MVP:提取当前网页正文或选中内容,保存到用户自己的 EdgeEver 实例。
## PWA 安装说明
@@ -73,6 +74,20 @@ PC 端请使用 Chrome/Edge 打开站点,点击地址栏右侧的“安装”
> 常见踩坑:移动端安装 PWA 时,建议优先使用 Chrome 或 Edge。其他移动浏览器在安装过程中可能出现兼容性问题或异常报错。
+## Chrome/Edge 网页裁剪插件
+
+仓库在 `apps/extension` 中包含一个 Chrome/Edge Manifest V3 网页裁剪插件。用户可以配置自己的 EdgeEver 实例和 API Token,然后将选中内容或当前文章保存为可搜索笔记。
+
+当前 MVP 在浏览器中使用 Mozilla Readability 提取正文,再使用 Turndown 转换为 Markdown。暂时还不会保存完整的单文件 HTML,也不会将网页资源上传到 R2。
+
+在仓库根目录构建插件:
+
+```sh
+bun run build:extension
+```
+
+然后打开 `chrome://extensions` 或 `edge://extensions`,开启开发者模式,加载 `apps/extension/dist`。API Token 至少需要 `read:notebooks` 和 `write:memos` 权限。
+
## 关于客户端
原生客户端已纳入 EdgeEver 的开发计划。移动端 App 计划基于 React Native 构建,桌面端 App 计划基于 Tauri 构建。
@@ -85,6 +100,7 @@ PC 端请使用 Chrome/Edge 打开站点,点击地址栏右侧的“安装”
- 官网:Astro 静态站点,位于 `apps/site`,可独立构建并部署到 Cloudflare Pages。
- 前端:Vite、React、React Router、TanStack Query,UI 基于 Tailwind CSS、shadcn/ui、Radix UI。
- 编辑器:TipTap / ProseMirror,支持 Markdown;PWA 使用 vite-plugin-pwa、Workbox、Dexie。
+- 网页裁剪:Manifest V3、Mozilla Readability、Turndown,支持 Chrome 与 Microsoft Edge。
- 后端:Cloudflare Workers、Hono、Zod、D1、R2,提供 REST API、OpenAPI 与 Remote MCP。
## 快速开始
@@ -118,6 +134,7 @@ bun run build
```text
apps/web Vite + React 前端、PWA、离线草稿与同步队列
+apps/extension Chrome/Edge Manifest V3 网页裁剪插件
apps/api Cloudflare Worker + Hono API、OpenAPI、MCP endpoint
apps/mobile Expo + React Native 移动端 App
apps/site Astro 官方网站,可独立部署