Skip to content

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

docs: refresh multi-language readmes with hero showcase and structured comparison

tianma-ifb63d0a68ba79
diff --git a/README.ja.md b/README.ja.md
index db82ad39..b77180b1 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -19,13 +19,14 @@
<p>
<a href="https://t.me/+wwUx1BYLrIdiZjY1"><img src="assets/readme/community/telegram.svg" alt="Telegram" width="16" height="16" align="absmiddle" /> Telegram グループ</a> &nbsp;|&nbsp;
<a href="https://demo.edgeever.org">🌐 オンラインデモ</a> &nbsp;|&nbsp;
- <a href="#クライアントのダウンロード">📱 ダウンロード</a> &nbsp;|&nbsp;
+ <a href="#全プラットフォームクライアントと拡張機能">📱 クライアントと拡張機能</a> &nbsp;|&nbsp;
<a href="#features">主な機能と活用シーン</a>
</p>
+ <p>
+ <img src="assets/readme/hero.png" alt="EdgeEver 3ペインワークスペースと AI パートナー画面" width="880" />
+ </p>
</div>
-
-
EdgeEver は、オープンソースのノートと知識ベースの作業領域です。クラシックで高効率な三ペインの作業体験(ツリー階層・ノート一覧・エディタ)を継承しつつ、データを自分で持ち、AI Agent と連携できます。
> 💡 **サーバーレス、ずっと無料**
@@ -37,10 +38,12 @@ EdgeEver は、オープンソースのノートと知識ベースの作業領
多くの**ノートアプリや個人知識ベース**のユーザーが求めているのは、**信頼でき、開かれていて、速い**個人知識ベースです。よくある代替には、それぞれ代償があります。
-* **Evernote**:かつては最もストレスがなく、滑らかなマルチデバイス即時クラウド同期を備えていました。しかし多機能な商業向けスイートへと進化するにつれ、広告や追加機能が増えてシステム負荷が高まりました。さらに無料枠の制限が厳格化され、高度な AI サブスクリプションも高額で、現代のセルフホストやプライベートな AI ワークフローとの柔軟な連携も難しくなっています。
-* **Obsidian**:ファイルは開いていますが、コアはクローズドです。公式同期は有料、第三者同期は手間がかかります。フラットなローカルファイル走査に依存するため、ノートが数千・数万件に増えたりプラグインを重ねると起動や検索がもたつきます。画像と添付をノートと一緒に置くと保管庫が膨らみ、モバイル同期が遅く、削除後に添付が残りやすいです。気軽な取り込みには重いことがあります。
-* **Memos などのタイムライン型**:簡潔ですが、三ペインの整理作業とはレイアウトが違います。
-* **思源ノート(SiYuan)などのブロック型知識ベース**:高機能でオープンソースのセルフホストに対応していますが、徹底した「ブロック(Block)」構造により日常的な気軽なメモや流れるような文章作成には心理的負荷がやや高くなります。また、サーバー費用ゼロの Serverless 運用形態がなく、マルチデバイス同期は公式の有料サブスクリプション、または S3/WebDAV 同期機能を有料でアンロックして自前ストレージを用意する必要があります。
+| ソリューション | 代表製品 | レイアウトと操作体験 | 同期とセルフホスト費用 | AI・Agent エコシステム |
+| :--- | :--- | :--- | :--- | :--- |
+| **商用クラウドノート** | Evernote | 3ペイン、経年により肥大化 | 無料枠縮小、有料プランが高額 | 閉鎖的で私有 AI との連携が困難 |
+| **ローカルファイル保管庫** | Obsidian | ローカルフォルダとタブ、大量時に遅延 | コア閉源、公式同期は有料、添付で肥大化 | コミュニティ頼み、公式 MCP/ACP 未搭載 |
+| **軽量カード/ブロック型** | Memos / 思源ノート | タイムラインや全ブロック構造で書く負担増 | サーバーが必要、または有料同期 | 断片メモ中心、長文と Agent の両立に難 |
+| **Serverless 全スタックオープン知識ベース** | **EdgeEver** | **伝統の3ペイン + リッチテキスト/Markdown 両対応** | **Cloudflare 無料枠でゼロ運用 / Docker 自前** | **ネイティブ Remote MCP & デスクトップ ACP 連携** |
**EdgeEver はその隙間を埋めます。** スタック全体がオープンソースで、**ストレスフリーかつ低遅延なマルチデバイス即時クラウド同期**を提供し、すべてのサービスを完全に無料でセルフホストできます。使い慣れた三ペインを残し、1万件のノートを抱えて常駐しても軽快でなめらか、ネイティブな AI Agent と手軽な導入も備えています。
@@ -50,7 +53,9 @@ EdgeEver は、オープンソースのノートと知識ベースの作業領
公開デモは毎日 3:00(中国標準時)にリセットされ、サンプルノートが戻ります。非公開の内容は置かないでください。
-## クライアントのダウンロード
+## 全プラットフォームクライアントと拡張機能
+
+### クライアントのダウンロード
<p>
<a href="https://github.com/tianma-if/edgeever/releases/latest"><img src="assets/readme/platforms/macos.svg" alt="macOS 向け EdgeEver をダウンロード" width="40" height="40" /></a>&nbsp;&nbsp;
@@ -62,34 +67,55 @@ EdgeEver は、オープンソースのノートと知識ベースの作業領
> iOS アプリは、中国本土以外の Apple ID が必要です。
+### ブラウザ Web クリッパー拡張機能
+
+<p>
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Google Chrome に EdgeEver Web クリッパーをインストール" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Microsoft Edge に EdgeEver Web クリッパーをインストール" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://addons.mozilla.org/ja/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Firefox に EdgeEver Web クリッパーをインストール" width="36" height="36" /></a>
+</p>
+
+- **スマートな本文抽出**:Web ページの本文を自動抽出し、クリーンな Markdown に変換。参照元 URL と取得日時を保持。
+- **選択範囲と右クリッククリップ**:テキストを選択するか画像を右クリックして、余分な要素を除いて即時ノート化。
+- **SNS と技術コミュニティへの深い対応**:X (Twitter)、小紅書、知乎、Reddit、GitHub、Bilibili、YouTube など 15 以上の主要プラットフォームに最適化。
+- **セルフホストへの直接安全通信**:取得した内容は中継サーバーを介さず、プライベートな自前インスタンスへ直接送信。
+
<a id="features"></a>
## 主な機能と活用シーン
マルチチャネルでの情報収集からビジュアル表現、チーム連携まで、EdgeEver は摩擦のないエンドツーエンドのワークフローを提供します:
-### 全方位のクリッピングとメディア蓄積
-- **クロスプラットフォームのワンクリック保存**:ブラウザ拡張は [小紅書ギャラリー](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping)、[X (Twitter) 投稿と引用](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping)、[知乎の回答](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping)、[Reddit](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping)、[GitHub](docs/best-practices.md#8-one-click-github-repository-metadata-clipping)、YouTube、Bilibili など 15 以上の主要 SNS・コミュニティ・メディアに深層対応;スマホのシステム共有による[画像](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes)や[微信記事](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile)のワンクリック保存にも対応。
-- **微信チャット履歴の完全取り込み**:macOS 版の微信で「他のアプリへ転送 → EdgeEver」を選ぶだけで、発言者、タイムライン、引用返信、スタンプを保持したまま構造化ノートとして一括取り込み。画像は自動埋め込みされ、動画やファイルは添付ファイルに変換されます。詳細は[微信チャット履歴の一括取り込み](docs/best-practices.md#1-one-click-wechat-chat-history-archiving)。
-- **汎用ファイル添付とクライアント側画像圧縮**:PDF、Office 文書、圧縮ファイル、動画・音声など各種添付ファイルを最大 1 GiB までチャンク分割・ストリーミング処理で安全にアップロード;ブラウザ側で静かに画像を自動圧縮し、スクリーンショットや大判画像を 50%〜90% 軽量化。
+### 注目の実機ワークフロー
+
+| 💡 AI 一言指示でマインドマップ・図解作成 | 📊 AI 業務多次元テーブルとオンラインフォーム |
+| :---: | :---: |
+| <img src="docs/assets/best-practices/ai-diagram-mindmap.png" alt="AI 一言指示でマインドマップ作成" width="420" /> | <img src="docs/assets/best-practices/ai-database-employee-roster.png" alt="AI 多次元テーブル構築" width="420" /> |
+| **💬 微信チャット履歴の構造化一括取り込み** | **🎨 微信公式アカウント・記事向けリッチ整形** |
+| <img src="docs/assets/best-practices/wechat-chat-imported-note.png" alt="微信チャット履歴取り込み" width="420" /> | <img src="docs/assets/best-practices/copy-to-wechat-mp-menu.png" alt="リッチテキスト整形コピー" width="420" /> |
+
+### 1. 全方位のクリッピングとメディア蓄積
+- **クロスプラットフォームのワンクリック保存**:拡張機能は [小紅書](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping)、[X (Twitter)](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping)、[知乎](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping)、[Reddit](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping)、[GitHub](docs/best-practices.md#8-one-click-github-repository-metadata-clipping)、Bilibili、YouTube に深層対応;スマホ共有から[画像](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes)や[記事](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile)を即時保存。
+- **微信チャット履歴の完全取り込み**:macOS 版で発言者、時間軸、画像、添付を保ったまま一括ノート化。詳細は[微信チャット履歴取り込み](docs/best-practices.md#1-one-click-wechat-chat-history-archiving)。
+- **汎用添付ファイルとクライアント側画像圧縮**:最大 1 GiB まで安全に添付可能;ブラウザ側での自動画像圧縮により 50%〜90% 容量を削減。
-### インテリジェントなビジュアル表現と多次元データ協調
-- **ビジュアル図解ノートとプロフェッショナルインフォグラフィック**:外部描画ツール不要で、AI アシスタントへの自然言語指示だけで編集可能な[マインドマップ・フローチャート・アーキテクチャ図](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams) を生成(詳細は[ビジュアル図解ノート設計ガイド](docs/visual-diagram-notes.md)、Mermaid コードブロックのネイティブ描画に対応);豊富なテンプレートから洗練された[多種多様なプロフェッショナルインフォグラフィック(タイムライン、比較図、象限マトリクスなど)](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics) をその場で作成。
-- **AI 多次元テーブルと公開集計フォーム**:AI プロンプトから[あらゆる業務シーンに応じた多次元テーブル](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt)(プロジェクト管理、コンテンツ企画、人事・資産台仗など)を自動構築し、タグや日付などのフィールドとサンプルデータを自動生成;ログイン不要の[一般公開オンライン集計フォーム](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables) をワンクリックで発行し、回答データをリアルタイムで収集・蓄積。
-- **ネイティブポスターノートと AI ビジュアルレイアウト**:キャンバスベースの構造化ポスターノートをネイティブサポートし、洗練されたカードテンプレートとレイアウトを内蔵;ダブルクリックでテキスト編集や画像・プレースホルダーの差し替えが可能で、ワンクリック適応ズームに対応;伴走型 AI アシスタントおよび ACP / MCP プロトコルを通じて、ポスターの生成・理解・共同推敲を直接実行可能。
-- **デュアルビュー編集・空間整理・知識ベースの公開**:リッチテキストと Markdown ソースビューを自在に切り替え可能;クラシックな 3 ペイン構成と幅調整可能なパネル、集中モード、無制限階層のノートブック、ノートの一括結合・移動、ドラッグ&ドロップ並べ替え;自動リビジョン履歴;パスワード保護付きの単一ノート共有に加え、**ノートブック全体をツリー構造ナビゲーション付きの独立した公開知識ベース Web サイトとしてワンクリック発行**可能(パスワード保護対応)。
+### 2. インテリジェントなビジュアル表現と多次元データ協調
+- **ビジュアル図解ノートとプロフェッショナルインフォグラフィック**:AI に指示するだけで編集可能な[マインドマップやフローチャート](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams) を自動生成([設計ガイド](docs/visual-diagram-notes.md));多彩な[インフォグラフィック](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics) を手軽に作成。
+- **AI 多次元テーブルと公開集計フォーム**:自然言語プロンプトから[多次元データベーステーブル](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt) を即座に構築;ログイン不要の[一般公開オンライン集計フォーム](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables) をワンクリックで発行。
+- **ネイティブポスターノートと AI レイアウト**:キャンバスベースのポスターノートを内蔵し、AI アシスタントと連携して美麗なグラフィックを直接デザイン。
+- **デュアルビュー編集と知識ベース公開**:リッチテキストと Markdown を自在に切替;**ノートブック全体を階層ツリー付きの独立 Web サイトとして公開**可能。
-### クリエイター向けワンクリック配信
-- **微信公式アカウント向け一括整形**:インライン CSS を保持した美化フォーマットに一発変換し、[微信公式アカウントへの直接コピー&ペースト](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs) に対応。外部整形ツールは不要です。
-- **高解像度ポスター画像共有とマルチ形式書き出し**:任意のノートをワンクリックで[美しいポスター画像カードとして共有](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing) 可能。多彩な高品位テーマ、モノグラムアバター、自適応タイポグラフィ、カスタムフォントやレイアウトを選択して SNS に発信でき、単一ノートの Markdown、HTML、PDF への書き出しにも対応。
-- **AI RSS 購読日報**:組み込みの公式 AI RSS 購読プラグインが、フィードやブログを自動巡回。AI がノイズを除去し、要点を整理した構造化日報ノートを定期生成します。
+### 3. クリエイター向けワンクリック配信
+- **微信公式アカウント向け一括整形**:インラインスタイル付きの美麗レイアウトへ瞬時に変換し、[エディタへ直接貼り付け](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs) 可能。
+- **高画質ポスター画像共有とマルチ形式書き出し**:ノートを[美麗な縦長ポスターカード](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing) として共有;Markdown、HTML、PDF への書き出しにも対応。
+- **AI RSS 購読日報**:公式 AI RSS プラグインが情報源を巡回し、ノイズを除去した構造化日報を自動生成。
-### ネイティブ AI Agent とオープンなエコシステム
-- **ネイティブ Agent プロトコル連携(MCP & ACP)**:組み込みの Model Context Protocol (MCP) により外部 AI Agent がノートを直接閲覧・整理可能;デスクトップ版は Agent Client Protocol (ACP) を通じてローカルで動作する各種 Agent(Codex、Antigravity、Claude Code、WorkBuddy など)を直接呼び出して共同作成。
-- **独自モデル連携とオープンなプラグイン API**:複数の OpenAI、Anthropic、Gemini 互換プロバイダやカスタム中継サービスと接続し、要約、論点整理、翻訳、推敲を支援;充実した[プラグイン開発 API](docs/plugin-development.md) で機能を自由に拡張可能。
+### 4. ネイティブ AI Agent とオープンなエコシステム
+- **ネイティブ Agent プロトコル連携(MCP & ACP)**:組み込みの MCP により外部 AI Agent が安全にノートを操作;デスクトップ版は ACP 経由でローカル Agent(Codex、Antigravity、Claude Code など)と協調作業。
+- **独自モデル連携とオープンなプラグイン API**:OpenAI、Anthropic、Gemini 互換プロバイダと連携;[プラグイン開発 API](docs/plugin-development.md) で自由に拡張可能。
-### オープンアーキテクチャ・マルチプラットフォーム・強固なセキュリティ
-- **柔軟なデプロイとオープンなデータ構造**:Cloudflare Serverless(無料枠で約 15 万件の短文ノートと約 5 万枚の画像を収容)でのゼロコスト運用、または VPS/NAS/自宅サーバーへの Docker デプロイ(数百万件規模に対応);標準 SQLite を採用し、REST API、CLI、完全な可逆 ZIP アーカイブ入出力によりデータロックインを排除。
-- **全プラットフォーム対応とエンタープライズ品質の安全性**:Web、[Android](https://play.google.com/store/apps/details?id=org.edgeever.mobile&hl=ja)、[macOS](https://github.com/tianma-if/edgeever/releases), [Windows](https://github.com/tianma-if/edgeever/releases/latest)、[Linux](https://github.com/tianma-if/edgeever/releases/latest)、[iOS](https://apps.apple.com/jp/app/edgeever/id6792625631) に公式対応(Web クリッパーは [Chrome](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo)、[Edge](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo)、[Firefox](https://addons.mozilla.org/ja/firefox/addon/edgeever-web-clipper/) をサポート);セルフホストでデバイス台数制限なし、メモリ消費を抑えた軽量デスクトップ動作、オフライン下書きと同期キュー、ブルートフォース攻撃対策、複数アカウントの完全な空間分離。
+### 5. オープンアーキテクチャ・マルチプラットフォーム・強固なセキュリティ
+- **柔軟なデプロイとオープンなデータ構造**:Cloudflare Serverless(無料枠で約15万件ノート対応)または Docker 自前運用;標準 SQLite、可逆 ZIP アーカイブ対応。
+- **全プラットフォーム対応とエンタープライズ品質の安全性**:Web、Android、iOS、macOS、Windows、Linux、ブラウザ拡張に対応;オフライン下書き、同期キュー、ブルートフォース保護。
👉 全 14 の実機スクリーンショットと解説を見る:**[完全な活用シーンとショーケースガイド](docs/best-practices.md)**
@@ -124,13 +150,16 @@ GitHub と Cloudflare のオンライン操作だけで EdgeEver を導入して
### 方法 B: 手動のオンライン導入
+<details>
+<summary>📖 クリックして展開:Web で行う 6 ステップの手動導入手順</summary>
+
ウェブ上の 6 手順で完了します。
1. **リポジトリを Fork**:GitHub 右上の **Fork** で、EdgeEver を自分のアカウントへ Fork します。
2. **Cloudflare リソースを作成**:D1 `edgeever` と R2 `edgeever-resources` を作ります。
3. **プロジェクトを取り込み、設定**:Cloudflare **Workers & Pages** で Fork の `main` ブランチから `edgeever` という名前の Worker を作成します。リポジトリのルートと、Cloudflare 上で実行される Workers Builds の既定のデプロイコマンドを使い、API トークンの D1 読み取り・編集権限を確認します。binding はデプロイコマンドが作るため、Fork 内のファイルは編集しないでください。
4. **管理者パスワードを準備**:管理者ログイン用パスワードを用意します。32 文字以上を推奨します。Worker 作成後、実行時 Secret `EDGE_EVER_AUTH_PASSWORD` に保存します。
-5. **ビルドと確認**:Save and Deploy で Worker が作成され、ビルドが始まります。管理者 Secret がないため失敗した場合は、手順 4 の実行時 Secret を追加して再試行します。管理者ユーザー名の既定値は `admin` です。別の名前を使う場合は、再試行前に Workers Builds 変数 `EDGE_EVER_AUTH_USERNAME` を設定します。導入後に `/api/health` が `200` を返すことを確認し、設定した管理者ユーザー名とパスワードでログインします。
+5. **ビルドと確認**:Save and Deploy で Worker が作成され、ビルドが始まります。初回のビルドは Worker インスタンスを初期化するためのものであり、管理者 Secret 未設定によるエラーは想定内の動作です。手順 4 の実行時 Secret `EDGE_EVER_AUTH_PASSWORD` を追加した後に再試行ボタンを押せばビルドが通過します。管理者ユーザー名の既定値は `admin` です。別の名前を使う場合は、再試行前に Workers Builds 変数 `EDGE_EVER_AUTH_USERNAME` を設定します。導入後に `/api/health` が `200` を返すことを確認し、設定した管理者ユーザー名とパスワードでログインします。
6. **自動更新を有効化**:Fork の **Actions** タブで **I understand my workflows, go ahead and enable them** を押し、**Update deployed EdgeEver** を一度手動実行して、今後の安定版と修正を自動で受け取れるようにします。
> 📖 手順と設定の詳細は [Online Deployment Guide](docs/deploy-cloudflare-button.md) を見てください。
@@ -139,165 +168,155 @@ GitHub と Cloudflare のオンライン操作だけで EdgeEver を導入して
> 💡 **Cloudflare R2 の有効化**:Cloudflare R2 にはノート用途で足りる [無料保存枠](https://developers.cloudflare.com/r2/pricing/#free-tier) がありますが、先に R2 のサブスクリプションを有効にし、支払い方法を登録する必要があります。Cloudflare は [公式に](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) UnionPay、Visa、Mastercard などのカードと、PayPal、Apple Pay、Google Pay などを受け付けます。
-### 方法 C: VPS または NAS で Docker
+</details>
+
+### 方法 C: VPS または NAS 上で Docker を使用
-GitHub ホストのインストーラと公式 GHCR イメージを使います。
+Docker と Cloudflare は同じフロントエンド、API ルート、ビジネスサービス、認証、MCP 実装、および migration を共有します。コンテナは SQLite を使用し、ローカルファイルまたは S3 互換ストレージに対応し、`amd64` と `arm64` イメージを提供します。詳細は[Docker によるデプロイ](docs/deploy-docker.md)と[セルフホストと Docker アーキテクチャ](docs/self-hosting-architecture.md)をご覧ください。
+
+GitHub でホストされているインストールスクリプトと公式 GHCR イメージを使用します。
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
-このコマンドは最新イメージを引き、管理者パスワードを生成し、Docker Compose で EdgeEver を起動します。
-
-手動導入と設定は [Docker deployment guide](docs/deploy-docker.md) を見てください。
+このコマンドは最新のイメージを取得し、管理者パスワードを生成して、Docker Compose で EdgeEver を起動します。導入後は毎日自動更新されます。手動更新する場合は、サーバー上で `~/edgeever/update.sh` を実行します。
-インストール後は既定で毎日自動更新されます。手動で更新する場合は、導入先のサーバーで `~/edgeever/update.sh` を実行してください。
+> 💡 **ネットワークの注意事項**:公式イメージは GitHub (GHCR) にあります。環境によって取得が遅い場合は、ネットワークプロキシやミラーを設定してください。
---
-## 複数アカウントとストレージ使用量
+## データ移行と高度な活用
-導入後、1 インスタンスで複数アカウントのログインができます。
+### 移行ガイド (Migration)
-インスタンス管理者は **プロフィール** -> **ユーザーアカウント** でメンバーの作成、無効化、パスワードリセットができます。メンバーごとにノートブック、ノート、添付、ゴミ箱、インポート / エクスポート、MCP トークンが分離されます。また、直感的なストレージ使用量ダッシュボードにより、インスタンス全体および各アカウントの添付ファイル容量をリアルタイムで把握できます。
+他のノートアプリから EdgeEver に移行する場合は、次のガイドを参照してください。
-## ブラウザ Web Clipper
+- **Evernote からの移行**:[docs/evernote-migration-guide.md](docs/evernote-migration-guide.md) を参照
+- **flomo からの移行**:[docs/flomo-migration-guide.md](docs/flomo-migration-guide.md) を参照
+- **Memos からの移行**:[docs/memos-migration-guide.md](docs/memos-migration-guide.md) を参照
+- **Notion からの移行**:[docs/notion-migration-guide.md](docs/notion-migration-guide.md) を参照
-<p>
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Google Chrome 向け EdgeEver Web Clipper を入れる" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Microsoft Edge 向け EdgeEver Web Clipper を入れる" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://addons.mozilla.org/ja/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Firefox 向け EdgeEver Web Clipper を入れる" width="36" height="36" /></a>
-</p>
+### ネイティブ MCP 連携
-- **スマートな本文抽出**:Web ページの本文を自動抽出し、クリーンな Markdown に変換。元記事の URL とクリップ日時を保持します。
-- **選択テキストと画像のクリップ**:テキストを選択するか画像を右クリックして、ページ全体を保存することなく直接ノートとして保存できます。
-- **SNS とコミュニティへの深層対応**:X (Twitter)、小紅書、知乎、Reddit、GitHub、YouTube、Bilibili など 15 以上の主要プラットフォームの構造化保存にワンクリックで対応。
-- **セルフホストへのプライベート直接通信**:クリップした内容は個人の EdgeEver インスタンスに直接送信され、第三者の中継サーバーを経由しません。
+**個人設定** -> **API / MCP** で API トークンを生成し、Remote MCP 設定をワンクリックでコピーすれば、Claude Code、Cursor、Antigravity、OpenClaw などの AI Agent に知識ベースの安全な管理を許可できます。テキストノート、ダイアグラム(マインドマップ、フローチャート、アーキテクチャ図)、多次元テーブル、ポスターノートの閲覧・編集に加え、ノートブック、タグ、添付、リビジョン履歴、テンプレート、プロンプトの管理もサポートします。
-## コミュニティとフィードバック
+> 💡 **シーンのヒント:**
+> AI を真のナレッジオーケストレーター、創作の副操縦士として活用しましょう。構想を一瞬で図解や多次元テーブルに変換し、AI Agent にプライベートな文脈を提供できます。EdgeEver の豊かな編集機能と洗練されたタイポグラフィにより、AI と共同で築いた資産はただのテキストにとどまらず、いつでも活用・配信できる上質な成果物となります。
+
+### 複数アカウントとストレージ使用量
-- 不具合、機能要望、導入の問題: [GitHub Issues](https://github.com/tianma-if/edgeever/issues)
-- コード貢献: [Contribution Guide](CONTRIBUTING.md) を読んでください。Fork を EdgeEver の導入にも使う場合、その `main` は導入専用にしてください。同期、開発、Pull Request は公式 `upstream/main` から切った別ブランチで行い、導入用 `main` では開発も Sync fork もしないでください。
+導入後、1 つのインスタンスで複数アカウントのログインをサポートします。管理者は **個人設定** -> **アカウント管理** でメンバーアカウントの作成、無効化、パスワードリセットを行えます。各メンバーにはノートブック、ノート、添付、ゴミ箱、インポート/エクスポート、MCP トークンなどが完全に独立した個人スペースが割り当てられます。ストレージ分析画面から、全体の容量とアカウント別の添付ファイル消費状況をリアルタイムで確認できます。
-### Telegram コミュニティ
+### 高度なオブジェクトストレージと PicGo 外部図床
-EdgeEver コミュニティへようこそ。Vibe Coding や AI を探求する仲間が集まり、最先端の AI 生産性と個人ナレッジベースのベストプラクティスを共有しています。
+- **OSS オブジェクトストレージ**:インスタンスの Owner は **設定 → 高度な設定 → OSS オブジェクトストレージ** で S3 互換ストレージを設定できます。ストレージを変更しても、既存の添付ファイルには影響しません。
+- **デスクトップ PicGo 連携**:デスクトップ版はローカルの PicGo クライアントと連携でき、ノートに画像を挿入する際に外部図床へ直接アップロードすることで、自前インスタンスのストレージ消費とトラフィックを最小化できます。
-👉 [EdgeEver の Telegram グループに参加](https://t.me/+wwUx1BYLrIdiZjY1)
+### プラグインとテーマ
-## プラグインとテーマ
+Web 版およびデスクトップ版は機能プラグインと外観テーマに対応しており、公式マーケット、GitHub、または Manifest URL からワンクリックでインストールし、ワークスペース全体で同期できます。開発者は `@edgeever/plugin-api` を用いて自由に拡張可能です。[プラグイン開発ガイド](docs/plugin-development.md)および[プラグインマーケットポリシー](docs/plugin-marketplace-policy.md)をご覧ください。
-Web とデスクトップは機能プラグインとカスタムテーマに対応し、公式マーケット、GitHub、Manifest URL から手軽に導入でき、作業領域を通じて同期されます。開発者は `@edgeever/plugin-api` で拡張できます。詳細は [plugin development guide](docs/plugin-development.md) と [marketplace submission policy](docs/plugin-marketplace-policy.md) を参照してください。
+---
+
+## 開発者ガイドとアーキテクチャ
-## 技術スタック
+### 技術スタック
-- Bun workspace の monorepo。Web、API、公式サイト、共有型パッケージ。
-- フロントエンド: Vite、React、React Router、TanStack Query、Tailwind CSS、shadcn/ui、Radix UI。
-- エディタ: TipTap / ProseMirror と Markdown。PWA は vite-plugin-pwa、Workbox、Dexie。
-- Android アプリ: `apps/mobile` の Expo + React Native。SQLite のローカル保存と差分同期。
-- iOS アプリ: `apps/ios` のネイティブ SwiftUI(iOS 17+)。同梱の TipTap EditorBundle、GRDB のローカルミラー / outbox、Android に揃えたシェル。
-- ネイティブデスクトップ: Electron + Rust sidecar。横断プラットフォームの操作感と、速いローカルデータ。SQLite でオフライン編集、復帰後の差分同期、ローカルバックアップ。
-- Web Clipper: Manifest V3、Mozilla Readability、Turndown。Chrome、Microsoft Edge、Firefox。
-- バックエンド: Hono / Zod の業務アプリ 1 式。REST API と Remote MCP。Cloudflare は Workers / D1 / R2、Docker は Bun / SQLite / ローカルファイルまたは S3。
-- 公式サイト: `apps/site` の Astro 静的サイト。Cloudflare Pages に出せます。
+- Bun workspace monorepo。Web、API、公式サイト、共有型定義パッケージを含みます。
+- フロントエンド:Vite、React、React Router、TanStack Query。UI は Tailwind CSS、shadcn/ui、Radix UI。
+- エディタ:TipTap / ProseMirror(Markdown 対応)。PWA は vite-plugin-pwa、Workbox、Dexie。
+- Android アプリ:`apps/mobile` の Expo + React Native。SQLite ローカルストレージと増量同期。
+- iOS アプリ:`apps/ios` のネイティブ SwiftUI(iOS 17+)。TipTap EditorBundle と GRDB ローカルミラー/outbox。
+- ネイティブデスクトップ版:Electron + Rust sidecar。ローカル SQLite によるオフライン編集と増量同期。
+- Web クリッパー:Manifest V3、Mozilla Readability、Turndown(Chrome、Microsoft Edge、Firefox 対応)。
+- バックエンド:Hono/Zod による REST API および Remote MCP。Cloudflare Workers/D1/R2、Docker は Bun/SQLite/ローカルファイルまたは S3。
+- 公式サイト:`apps/site` の Astro 静的サイト。Cloudflare Pages に独立してデプロイ可能。
-## クイックスタート
+### クイックスタート
```sh
bun install
bun run dev
```
-ローカル開発は自動ログインします。新しいデータベースの初期アカウントは `owner` / `edgeever-local-dev` です。ログイン画面を試すときはログアウトしてください。
+ローカル開発環境では自動ログインが有効になっており、初期アカウントは `owner` / `edgeever-local-dev` です。
-## リポジトリ構成
+### ディレクトリ構成
```text
-apps/web Vite + React フロントエンド、PWA、オフライン下書き、同期キュー
-apps/extension Chrome/Edge/Firefox Manifest V3 Web Clipper
-apps/api Cloudflare Worker + Hono API、MCP
-apps/mobile Expo + React Native の Android アプリ
-apps/ios ネイティブ SwiftUI の iOS アプリ(TipTap EditorBundle、GRDB)
-apps/desktop Electron のデスクトップシェル、preload、ネイティブ梱包
-apps/site Astro の公式サイト。独立して導入できます
+apps/web Vite + React フロントエンド、PWA、オフライン下書きと同期キュー
+apps/extension Chrome/Edge/Firefox Manifest V3 Web クリッパー拡張
+apps/api Cloudflare Worker + Hono API、MCP エンドポイント
+apps/mobile Expo + React Native Android アプリ
+apps/ios ネイティブ SwiftUI iOS アプリ (TipTap EditorBundle, GRDB)
+apps/desktop Electron デスクトップシェル、preload bridge、ネイティブパッケージ設定
+apps/site Astro 公式サイト(単独デプロイ可能)
packages/client Web とモバイルで共有する API クライアント
-packages/shared 共有型、Zod、TipTap / Markdown 変換
+packages/shared 共有型定義、Zod スキーマ、TipTap / Markdown 変換
crates/desktop-sidecar
- ローカル SQLite、オフラインデータ、バックアップ、リソースの Rust sidecar
-scripts Wrangler ラッパ、パスワード hash、CLI、MCP stdio、Evernote ENEX 取り込み
-migrations D1/SQLite 共用の、追加のみの migration
-docs アーキテクチャ、移行、導入の文書
-.github/workflows Web、モバイル、iOS、デスクトップ梱包、導入、Release の CI
-wrangler.toml Cloudflare Workers、Assets、D1、R2 の設定
+ Rust sidecar。ローカル SQLite、オフラインデータ、バックアップを管理
+scripts Wrangler ラッパー、パスワードハッシュ、CLI、MCP stdio bridge、ENEX 取り込み
+migrations D1/SQLite で共用される追記専用のデータベース migration
+docs アーキテクチャ、移行、デプロイに関するドキュメント
+.github/workflows Web、モバイル、iOS、デスクトップのビルド、デプロイ、Release CI
+wrangler.toml Cloudflare Workers、Assets、D1、R2 設定
```
-## 内容の形式
+<details>
+<summary>⚙️ アーキテクチャ設計と同期の実装詳細(クリックして展開)</summary>
-EdgeEver はノート本文を 3 つの形で持ちます。
+#### コンテンツ形式
+
+EdgeEver は 3 つのコンテンツ表現を同時に保持します。
```text
-content_json TipTap/ProseMirror 文書。エディタの正本
-content_markdown API、Agent、取り込み、書き出し
-content_text 検索、要約、索引
+content_json TipTap/ProseMirror ドキュメント。エディタの正式形式
+content_markdown API、AI Agent、インポート/エクスポート用
+content_text 検索、要約、インデックス用
```
-**プロフィール** -> **インポートとエクスポート** から EdgeEver ZIP を書き出し、または取り込めます。`notes/` は Markdown として読め、持ち出せます。構造化データは EdgeEver インスタンス間の完全復元に使います。取り込みは関係ない対象データを残し、同じ EdgeEver ID の記録は上書きします。
-
-## MCP
+**個人設定** -> **インポートとエクスポート** から EdgeEver ZIP をエクスポートまたはインポートします。ZIP 内の `notes/` ディレクトリはそのまま Markdown として閲覧や移行に使用でき、構造化データは EdgeEver インスタンス間での完全復元に利用されます。
-**プロフィール** -> **API / MCP** で API トークンを作成し、ワンクリックで Remote MCP 設定をコピーすることで、Claude Code、Cursor、Antigravity、OpenClaw などの AI Agent がアカウント権限の範囲内で知識ベースを安全に管理できます。テキストノート、図のノート(マインドマップ、フローチャート、アーキテクチャ図)、多次元テーブルノート、ネイティブポスターノートの完全な CRUD に対応し、Agent はノートブック階層、タグ、添付ファイル、履歴バージョン、ノートテンプレート、AI 指示の管理も行えます。
+#### 画像圧縮の仕様
-> 💡 **着想:**
-> AI を知識の整理役と創作の相棒にしてください。構想をインタラクティブなマインドマップ、フローチャート、アーキテクチャ図、多次元テーブルへ瞬時に落とし込み、Agent に私有の文脈を渡せます。EdgeEver のリッチテキストと美しい体裁と組み合わせることで、AI が手伝った内容は、整った、いつでも配布できる高品質な知識資産になります。
+画像圧縮は Web クライアントでのアップロード前にのみ実行され、設定の「ノート内画像を圧縮」スイッチで制御されます。有効にすると、ブラウザが PNG、JPEG、WebP、AVIF を WebP に圧縮し、長辺を `2560px` 以内に収めます。圧縮によってサイズが縮小しない場合は原画が保持されます。
-## 画像圧縮
+Cloudflare Worker 側での画像処理はリソースを消費するため、EdgeEver では圧縮処理を Web クライアント側で完結させています。REST API や MCP からのアップロードはクライアントから送られたデータをそのまま保存します。
-画像圧縮は Web クライアントがアップロード前に行い、**ノート内画像を圧縮** の設定で制御します。オンのとき、PNG、JPEG、WebP、AVIF は得があれば WebP にし、長辺を `2560px` までにします。小さくならなければ原ファイルを残します。
+#### 同期タイミング
-Worker 側の画像処理は避け、計算と画像処理枠を抑えます。REST API と MCP のアップロードは、クライアントが渡した内容を追加圧縮せず保存します。
+Web、PWA、デスクトップ版は編集停止から 30 秒後にノートをアップロードし、画面表示中は 5 分ごとにクラウドの変更を確認します。ウィンドウへのフォーカス時や手動更新時は即時に反映されます。設定は [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) の `DEFERRED_MEMO_SYNC_DELAY_MS` と `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS` で調整可能です。
-## 高度なオブジェクトストレージとサードパーティ画像ホスティング
+</details>
-- **OSS オブジェクトストレージ**:インスタンスのオーナーは **設定 → 詳細 → OSS オブジェクトストレージ** で S3 互換ストレージを設定できます。切り替えは既存添付を移さず、影響しません。
-- **デスクトップ版 PicGo 連携**:デスクトップ版ではローカルの PicGo クライアントと連携可能で、ノート内の画像を GitHub、SM.MS、又拍雲、七牛雲や自前ホストへ直接アップロードでき、セルフホスト環境のストレージと帯域消費を節約できます。
-
-## 移行
-
-他のプラットフォームから EdgeEver へ移す場合は、次の短いガイドを見てください。
-
-- **Evernote からの移行**: [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
-- **flomo からの移行**: [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
-- **Memos からの移行**: [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
-- **Notion からの移行**: [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-
-## Docker 導入
-
-Docker は Cloudflare と同じフロントエンド、API、サービス、認証、MCP、migration です。コンテナは SQLite と、ローカルファイルまたは S3 互換の添付保存を使い、`amd64` と `arm64` に対応します。 [Deploy EdgeEver with Docker](docs/deploy-docker.md) と [Self-hosting and Docker architecture](docs/self-hosting-architecture.md) を見てください。
+---
-## 同期のタイミング
+## コミュニティとフィードバック
-Web、PWA、デスクトップは、編集が 30 秒止まったあとでノートをアップロードし、表示中は 5 分ごとに遠隔の変更を見ます。フォーカスと手動更新はすぐです。`DEFERRED_MEMO_SYNC_DELAY_MS` と `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS` は [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) で変えられます。
+- 不具合報告や機能提案、導入時の疑問は [GitHub Issues](https://github.com/tianma-if/edgeever/issues) へ投稿してください。
+- コントリビューションの前に [CONTRIBUTING.md](CONTRIBUTING.md) をお読みください。
## スポンサーと支援
-EdgeEver は無料のオープンソースプロジェクトです。クロスプラットフォームクライアント(macOS、Windows、Linux、iOS、Android)の継続的な開発、実機テスト、コード署名、複数ランタイムのエコシステム維持には、継続的な時間とリソースの投入が必要です。
+EdgeEver は無料のオープンソースプロジェクトです。各プラットフォーム向けの開発、実機テスト、証明書署名、マルチランタイムエコシステムの維持には継続的な労力とリソースが必要です。
-- [EdgeEver を支援する](docs/sponsor.md) — WeChat Pay または Alipay による自发的な寄付
-- [スポンサーとパートナー](docs/partners.md) — インフラ、開発ツール、サービス、コミュニティ連携の支援
+- [EdgeEver を支援する](docs/sponsor.md)
+- [スポンサーとパートナー](docs/partners.md)
## 謝辞
-- ノート製品の設計は、[Evernote](https://evernote.com/) や [Notion](https://www.notion.com/) など成熟したノートツールの公開されている製品体験も参考にしています。関連機能は EdgeEver が独自に設計し、実装しています。
-- マインドマップと視覚的な図のノートは、[XMind](https://xmind.com/) と [ProcessOn](https://www.processon.com/) の公開されている製品体験を参考にしています。関連機能は EdgeEver が独自に設計し、実装しています。
-- EdgeEver のポスターデザイン機能は、向阳乔木(joeseesun)の [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) を参考にし、MIT ライセンスに基づいてテンプレートと文字組みエンジンを改変して利用しています。
-- EdgeEver の画像共有カードのテーマデザインと文字組みは、[流光卡片(Firefly Card)](https://fireflycard.shushiai.com/) を参考にしています。デザインから得た着想に感謝します。
+- 製品設計にあたり、[Evernote](https://evernote.com/) や [Notion](https://www.notion.com/) などの公開製品体験を参考にしています。
+- 図解ノートは [XMind](https://xmind.com/) や [ProcessOn](https://www.processon.com/) の公開デザインを参考にしています。
+- ポスターキャンバスは、向陽喬木(joeseesun)氏の [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) をベースに改編しています(MIT ライセンス)。
+- 画像共有カードのビジュアルスタイルは [流光卡片 (FireflyCard)](https://fireflycard.shushiai.com/) を参考にしています。
-## 商標とブランド
+## 商標とブランドの利用
-EdgeEver の名称、ロゴ、その他のブランド表示は公式プロジェクトを区別します。Fork や改変版は EdgeEver に基づくと述べられますが、公式であるように装ったり、利用者を誤認させたりしてはなりません。オープンソースライセンスは商標権を与えません。ほかの利用は、メンテナの事前の書面による許可が必要です。
+EdgeEver の名称、ロゴ、ブランドアセットは公式プロジェクトを識別するためのものです。派生版で「EdgeEver に基づく」旨を明記することは可能ですが、公式であるかのように誤認させる表示は禁止されています。
-## 免責
+## 免責事項
-EdgeEver は、個人とコミュニティが開発・維持する独立したオープンソースのノートアプリです。Evernote Corporation およびその関係会社と提携、認可、後援、推奨の関係はありません。
+EdgeEver は完全に独立したオープンソースソフトウェアです。Evernote® およびその関連企業との提携、認可、後援関係はありません。
-EdgeEver はセルフホスト型ソフトウェアです。公式デモを除き、メンテナはユーザー内容をホスト、管理、審査しません。インスタンスに保存または表示される内容は、その利用者または運用者の責任であり、メンテナの見解ではありません。
+EdgeEver はセルフホスト型ソフトウェアです。公式デモを除き、プロジェクト管理者が利用者のコンテンツをホスト、管理、検閲することはありません。
diff --git a/README.md b/README.md
index 51353282..7c014eec 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,14 @@
<p>
<a href="https://t.me/+wwUx1BYLrIdiZjY1"><img src="assets/readme/community/telegram.svg" alt="Telegram" width="16" height="16" align="absmiddle" /> Telegram Group</a> &nbsp;|&nbsp;
<a href="https://demo.edgeever.org">🌐 Live Demo</a> &nbsp;|&nbsp;
- <a href="#client-downloads">📱 Client Downloads</a> &nbsp;|&nbsp;
+ <a href="#all-platform-clients--browser-extension">📱 Download Clients & Extension</a> &nbsp;|&nbsp;
<a href="#features">Key Features & Workflows</a>
</p>
+ <p>
+ <img src="assets/readme/hero.png" alt="EdgeEver Three-Pane Workspace & AI Companion Interface" width="880" />
+ </p>
</div>
-
-
EdgeEver is a modern, open-source notes and knowledge base workspace. It preserves the classic, high-efficiency three-pane productivity workflow (Tree View · Note List · Editor) while offering an open data architecture and seamless AI Agent integration for complete ownership and smart productivity.
> 💡 **Serverless & 100% Free Forever**
@@ -35,12 +36,14 @@ EdgeEver is a modern, open-source notes and knowledge base workspace. It preserv
## Why EdgeEver
-Many users of **note-taking apps and personal knowledge bases** simply want a **reliable, open, and fast** personal knowledge base. However, existing mainstream solutions all present tradeoffs:
+Many users of **note-taking apps and personal knowledge bases** simply want a **reliable, open, and fast** personal knowledge base. Existing mainstream solutions all present tradeoffs:
-* **Evernote**: Once offered the smoothest, most seamless multi-device cloud sync experience. Yet as it evolved into a full-featured commercial suite, ads and add-ons multiplied while system overhead climbed. Meanwhile, free-tier quotas tightened, premium AI subscriptions grew expensive, and it remains difficult to integrate into modern self-hosted and private AI workflows.
-* **Obsidian**: Open files, closed-source core. Official Sync is paid and third-party sync is tedious; relying entirely on flat local file scanning causes noticeable cold-start and search lag once notes reach thousands or heavy plugins are loaded; storing images and attachments alongside notes quickly bloats vaults, making mobile sync sluggish and leaving orphaned files behind; and it is overly heavy for lightweight, capture-anywhere use.
-* **Memos & Stream Notes**: Clean and simple, but their social-timeline layouts differ fundamentally from the structured productivity of a classic three-pane workflow.
-* **SiYuan & Block-based PKMs**: Powerful with self-hosting support, but their granular "block-level" architecture imposes noticeable cognitive overhead for quick daily capture and continuous prose writing. Furthermore, they lack a true zero-cost serverless deployment tier, and multi-device sync relies on paid official subscriptions or paying extra to unlock S3/WebDAV sync features with your own storage.
+| Solution Type | Typical Apps | Layout & User Experience | Sync Mechanism & Hosting Cost | AI & Agent Ecosystem |
+| :--- | :--- | :--- | :--- | :--- |
+| **Traditional Cloud PKM** | Evernote | Classic 3-pane layout, bloated over time | Tightening free tier, expensive subscription | Closed ecosystem, hard to plug into private AI |
+| **Local File Vaults** | Obsidian | Local folders & tabs, lags with massive notes | Closed core, paid official sync, bloated attachments | Relies on community plugins, no native MCP/ACP |
+| **Lightweight Card / Block PKM** | Memos / SiYuan | Stream cards or granular block architecture | Requires self-hosted server, or paid official sync | Focused on atomic notes, cognitive overhead for prose |
+| **Serverless Full-Stack Open PKM** | **EdgeEver** | **Classic 3-Pane + Rich Text & Markdown Dual View** | **Zero-Cost Cloudflare Serverless / Docker On-Premise** | **Native Built-In Remote MCP & Desktop ACP Protocol** |
**EdgeEver fills this gap**: The entire stack is open source, delivering truly **seamless, low-latency, instant multi-device cloud sync** with full self-hosting freedom. It keeps the three-pane layout you know, stays silky-smooth and lightweight even with 10,000+ notes, and ships native AI agents with zero-cost deployment.
@@ -50,7 +53,9 @@ Many users of **note-taking apps and personal knowledge bases** simply want a **
The public demo resets every day at 3:00 AM (China Standard Time) and restores sample notes. Do not store private content there.
-## Client Downloads
+## All-Platform Clients & Browser Extension
+
+### Client Downloads
<p>
<a href="https://github.com/tianma-if/edgeever/releases/latest"><img src="assets/readme/platforms/macos.svg" alt="Download EdgeEver for macOS" width="40" height="40" /></a>&nbsp;&nbsp;
@@ -62,34 +67,55 @@ The public demo resets every day at 3:00 AM (China Standard Time) and restores s
> The iOS app requires an Apple ID from outside mainland China.
+### Browser Web Clipper Extension
+
+<p>
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Install EdgeEver Web Clipper for Google Chrome" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Install EdgeEver Web Clipper for Microsoft Edge" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Install EdgeEver Web Clipper for Firefox" width="36" height="36" /></a>
+</p>
+
+- **Smart Article Extraction**: Automatically extracts clean article content into Markdown, preserving source URL and timestamp.
+- **Selection & Context Menu Clipping**: Clip selected text or right-click any image to create a note instantly without clutter.
+- **Deep Social & Community Support**: Tailored adapters for X (Twitter), Xiaohongshu, Zhihu, Reddit, GitHub, Bilibili, and YouTube.
+- **Direct Self-Hosted Privacy**: Clips transmit straight to your private instance without third-party server relay.
+
<a id="features"></a>
## Key Features & Workflows
From multi-channel inspiration capture to deep visual expression and team collaboration, EdgeEver delivers frictionless, end-to-end workflows:
-### Universal Clipping & Media Storage
-- **Cross-Platform One-Click Clipping**: Browser extension deeply adapts to 15+ major social, community, and media platforms, including [Xiaohongshu galleries](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping), [X (Twitter) posts & quotes](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping), [Zhihu Q&As](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping), [Reddit](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping), [GitHub](docs/best-practices.md#8-one-click-github-repository-metadata-clipping), YouTube, and Bilibili; one-click mobile system share clipping for [photos](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes) and [WeChat articles](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile).
-- **WeChat Chat History Archiving**: One-click complete transcript import on macOS via WeChat "Forward to Other Apps → EdgeEver", preserving participants, timestamps, quoted replies, and stickers, with images embedded and audio/video files saved as note attachments. See [One-Click WeChat Chat History Archiving](docs/best-practices.md#1-one-click-wechat-chat-history-archiving).
-- **Universal File Attachments & Client-Side Image Compression**: Easily upload and attach PDFs, Office documents, archives, and multimedia files, safely handling up to 1 GiB attachments via chunked streaming; silent client-side image compression in the browser reduces screenshots and large images by 50%-90% for faster loading and minimal storage use.
+### Featured Workflows in Action
+
+| 💡 One-Prompt AI Mind Maps & Diagrams | 📊 AI Database Tables & Online Forms |
+| :---: | :---: |
+| <img src="docs/assets/best-practices/ai-diagram-mindmap.png" alt="AI Mind Map Generation" width="420" /> | <img src="docs/assets/best-practices/ai-database-employee-roster.png" alt="AI Database Tables" width="420" /> |
+| **💬 One-Click WeChat Chat History Archiving** | **🎨 WeChat Official Account & Newsletter Styling** |
+| <img src="docs/assets/best-practices/wechat-chat-imported-note.png" alt="WeChat Chat Archiving" width="420" /> | <img src="docs/assets/best-practices/copy-to-wechat-mp-menu.png" alt="Copy Formatted Rich Text" width="420" /> |
+
+### 1. Universal Clipping & Media Storage
+- **Cross-Platform One-Click Clipping**: Extension tailored for [Xiaohongshu](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping), [X (Twitter)](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping), [Zhihu](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping), [Reddit](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping), [GitHub](docs/best-practices.md#8-one-click-github-repository-metadata-clipping), YouTube, and Bilibili; one-click mobile sharing for [photos](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes) and [articles](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile).
+- **WeChat Chat History Archiving**: One-click complete transcript import on macOS preserving participants, timestamps, attachments, and stickers. See [WeChat Archiving](docs/best-practices.md#1-one-click-wechat-chat-history-archiving).
+- **Universal Attachments & Client Image Compression**: Handles up to 1 GiB files; silent in-browser image compression shrinks files by 50%-90%.
-### Intelligent Visual Notes & Database Collaboration
-- **Visual Diagram Notes & Professional Infographics**: Ditch external diagramming tools—prompt the companion AI assistant to generate interactive, editable [mind maps, flowcharts & architecture diagrams](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams) (see [Visual Diagram Notes Design Guide](docs/visual-diagram-notes.md), with native Mermaid code block rendering); use the built-in template gallery to generate stylized, versatile [infographics across all formats (timelines, comparisons, quadrant matrices, etc.)](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics) in-place.
-- **AI Multi-Dimensional Tables & Public Forms**: Generate structured [multi-dimensional tables for any business workflow](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt) (such as project tracking, content banks, and HR rosters) via natural language AI prompts, inferring tags, dates, and rich field types with sample rows; publish [public online collection forms](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables) with one click without login requirements, syncing submitted responses in real time.
-- **Native Poster Notes & AI Visual Layout**: Native canvas-based structured poster notes with rich visual card templates and curated layouts; double-click to edit copy or replace images and placeholders with one-click responsive zoom; companion AI assistants and ACP / MCP protocols can directly compose, interpret, and refine poster content.
-- **Dual-View Editing, Space Organization & Public Knowledge Base**: Smoothly toggle between rich-text and raw Markdown views on desktop; classic 3-pane layout with resizable panel width, one-click Focus Mode, infinite-depth notebooks, batch note merging/moving, and drag-and-drop sorting; automatic revision history; beyond password-protected single note sharing, publish **entire notebooks as standalone, navigable knowledge base websites** with hierarchical directory trees and password protection.
+### 2. Intelligent Visual Notes & Database Collaboration
+- **Visual Diagram Notes & Professional Infographics**: Prompt the AI companion to generate editable [mind maps & flowcharts](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams) (see [Design Guide](docs/visual-diagram-notes.md)); built-in templates produce [infographics](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics) instantly.
+- **AI Multi-Dimensional Tables & Public Forms**: Natural language prompts build [structured database tables](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt) with sample rows; launch [public collection forms](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables) without login barriers.
+- **Native Poster Notes & AI Visual Layout**: Canvas-based structured poster notes with rich visual card layouts, responsive zooming, and direct AI companion collaboration.
+- **Dual-View Editing & Public Knowledge Base**: Seamlessly toggle between rich-text and raw Markdown; publish **entire notebooks as standalone, navigable knowledge base websites**.
-### Creator Publishing & Effortless Distribution
-- **WeChat Official Account & Rich Copy**: Designed for creators, transform notes into beautifully formatted rich text with inline CSS, featuring [one-click note copy to WeChat Official Account](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs) editor, newsletters, or blogs without extra tools.
-- **Elegant Long-Image Posters & Multi-Format Export**: Turn any note into an [elegant image poster card](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing) with one click, featuring refined visual themes, monogram avatars, adaptive typography, and layout options for sharing on social platforms; export individual notes to Markdown, HTML, or PDF effortlessly.
-- **AI RSS Daily Digests**: Built-in official AI RSS subscription plugin that automatically aggregates feeds and blogs, filters out noise with AI, and compiles concise, well-structured daily digest notes.
+### 3. Creator Publishing & Effortless Distribution
+- **WeChat Official Account & Rich Copy**: Transform notes into styled rich text with inline CSS, featuring [one-click copy](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs) directly to newsletter editors.
+- **Elegant Long-Image Posters & Multi-Format Export**: Turn notes into [stylized image poster cards](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing); export individual notes to Markdown, HTML, or PDF effortlessly.
+- **AI RSS Daily Digests**: Built-in AI RSS plugin aggregates feeds, filters noise, and compiles concise daily digest notes.
-### Native AI Agents & Open Ecosystem
-- **Native Agent Protocols (MCP & ACP)**: Built-in Model Context Protocol (MCP) enables external AI Agents to read and organize notes; desktop app integrates Agent Client Protocol (ACP) to drive local agents (Codex, Antigravity, Claude Code, WorkBuddy, etc.) directly for collaborative creation.
-- **Bring Your Own AI Models & Extensible Plugin API**: Connect multiple OpenAI, Anthropic, Gemini compatible providers and custom proxies to summarize, extract insights, proofread, translate, and refine writing; customize and extend EdgeEver via comprehensive [Plugin Development APIs](docs/plugin-development.md).
+### 4. Native AI Agents & Open Ecosystem
+- **Native Agent Protocols (MCP & ACP)**: Built-in MCP lets external AI Agents read and organize notes; desktop app uses ACP to drive local agents (Codex, Antigravity, Claude Code, etc.) collaboratively.
+- **Bring Your Own AI Models & Extensible Plugin API**: Connect OpenAI, Anthropic, Gemini compatible providers; extend features via [Plugin Development APIs](docs/plugin-development.md).
-### Open Architecture, Cross-Platform & Security Foundation
-- **Flexible Deployment & Unlocked Data**: Run for free on Cloudflare Serverless (~150k short notes and ~50k images on the free tier), or deploy via Docker to your VPS, NAS, or home server for millions of notes; built on standard SQLite with REST APIs, CLI tooling, and lossless full ZIP export/import to keep your data completely independent.
-- **All-Platform Coverage & Production Security**: Official client support across Web, [Android](https://play.google.com/store/apps/details?id=org.edgeever.mobile), [macOS](https://github.com/tianma-if/edgeever/releases), [Windows](https://github.com/tianma-if/edgeever/releases/latest), [Linux](https://github.com/tianma-if/edgeever/releases/latest), and [iOS](https://apps.apple.com/us/app/edgeever/id6792625631), with web clipper extensions for [Chrome](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo), [Edge](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo), and [Firefox](https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/); self-hosted synchronization without device limits, lightweight memory footprint on desktop, offline drafts with sync queues, server-side brute-force protection, and isolated multi-user workspaces.
+### 5. Open Architecture, Cross-Platform & Security Foundation
+- **Flexible Deployment & Unlocked Data**: Run on Cloudflare Serverless (~150k notes for free) or Docker on-premise; standard SQLite storage with lossless full ZIP export/import.
+- **All-Platform Coverage & Production Security**: Official clients across Web, Android, iOS, macOS, Windows, Linux, and browsers; offline drafts, sync queues, and brute-force protection.
👉 Explore all 14 step-by-step showcases with screenshots: **[Complete Showcase & Workflows Guide](docs/best-practices.md)**
@@ -125,180 +151,173 @@ Deploy EdgeEver entirely through GitHub and Cloudflare:
### Option B: Manual Online Deployment
+<details>
+<summary>📖 Click to expand: 6-Step Web Manual Deployment Guide</summary>
+
Complete setup in 6 web steps:
1. **Fork the Repository**: Click **Fork** at the top right of GitHub to fork EdgeEver into your personal account.
2. **Create Cloudflare Resources**: Create D1 `edgeever` and R2 `edgeever-resources`.
3. **Import & Configure the Project**: Create a Worker named `edgeever` from the Fork's `main` branch in Cloudflare **Workers & Pages**. Use the repository root and keep Cloudflare's default Workers Builds deploy command, which runs in Cloudflare. Ensure its API token can read and edit D1. The deploy command creates the bindings; do not edit Fork files.
4. **Choose the Administrator Password**: Choose an administrator password, preferably at least 32 characters. Once the Worker is created, save it as the runtime Secret `EDGE_EVER_AUTH_PASSWORD`.
-5. **Build & Verify**: Save and Deploy creates the Worker and starts a build. If it fails because the administrator Secret is missing, add the runtime Secret from step 4 and retry. The username defaults to `admin`; to use another, set the `EDGE_EVER_AUTH_USERNAME` Workers Builds variable before retrying. Once deployed, confirm `/api/health` returns `200`, then log in with the configured username and password.
+5. **Build & Verify**: Save and Deploy creates the Worker and starts a build. The initial build primarily initializes the Worker instance; if it fails due to missing administrator Secret, this is expected behavior. Simply add the runtime Secret `EDGE_EVER_AUTH_PASSWORD` from Step 4 and click retry. The username defaults to `admin`; to use another, set `EDGE_EVER_AUTH_USERNAME` as a Workers Builds variable before retrying. Once deployed, confirm `/api/health` returns `200`, then log in with the configured username and password.
6. **Enable Automatic Updates**: Open the Fork's **Actions** tab, click **I understand my workflows, go ahead and enable them**, then manually run **Update deployed EdgeEver** once so the Fork can automatically receive future stable releases and fixes.
> 📖 For full step-by-step instructions and configuration details, see the [Online Deployment Guide](docs/deploy-cloudflare-button.md).
> 💡 **Custom Domain & Access**: After deployment, you can directly use the default `*.workers.dev` domain assigned by Cloudflare, or attach your own custom domain in the Worker settings under **Settings → Domains & Routes**.
-> 💡 **Cloudflare R2 Activation**: Although Cloudflare R2 offers a generous [free storage allowance](https://developers.cloudflare.com/r2/pricing/#free-tier) that note-taking workloads remain completely within, you must first activate an R2 subscription and add a payment method. Cloudflare [officially supports](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) UnionPay, Visa, Mastercard, and other cards, as well as PayPal, Apple Pay, Google Pay, and other payment methods.
+> 💡 **Enabling Cloudflare R2**: While Cloudflare R2 provides a generous [free storage tier](https://developers.cloudflare.com/r2/pricing/#free-tier) that will never be exceeded in typical note-taking, enabling R2 requires activating an R2 subscription and adding a payment method. Cloudflare [officially supports](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) UnionPay, Visa, Mastercard, PayPal, Apple Pay, Google Pay, and other methods.
+
+</details>
-### Option C: Docker on a VPS or NAS
+### Option C: Deploy with Docker on VPS or NAS
+
+Docker runs the same frontend, API routes, services, authentication, MCP implementation, and migrations as Cloudflare. The container uses SQLite with local files or S3-compatible attachment storage and supports `amd64` and `arm64`. See [Deploy EdgeEver with Docker](docs/deploy-docker.md) and [Self-hosting and Docker architecture](docs/self-hosting-architecture.md).
-Use the GitHub-hosted installer and the official GHCR image:
+Run the official installation script hosted on GitHub with the official GHCR container image:
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
-The command pulls the latest image, generates an administrator password, and starts EdgeEver with Docker Compose.
+This pulls the latest image, generates an administrator password, and starts EdgeEver via Docker Compose. Daily auto-updates are enabled by default; to update manually, run `~/edgeever/update.sh` on the server.
-See the [Docker deployment guide](docs/deploy-docker.md) for manual deployment and configuration.
-
-After installation, updates run automatically each day by default. To update manually, run `~/edgeever/update.sh` on the deployment server.
+> 💡 **Network Note**: The official image is hosted on GitHub Container Registry (GHCR). If pulls are slow in certain network environments, configure an appropriate network proxy or mirror.
---
-## Multi-Account Login & Storage Usage
+## Migration & Advanced Setup
-Once deployed, a single instance supports multi-account login.
+### Migration
-The instance administrator can create, disable, or reset member accounts in **Profile** -> **User accounts**. Each member gets a fully isolated personal workspace, including notebooks, notes, attachments, Trash, import/export, and MCP tokens. An intuitive storage usage dashboard provides real-time visibility into attachment storage consumed across the whole instance as well as per account.
+If you want to migrate notes from other platforms to EdgeEver, please refer to the following simple migration guides:
-## Browser Web Clipper
+- **Evernote Migration**: Please refer to [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
+- **flomo Migration**: Please refer to [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
+- **Memos Migration**: Please refer to [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
+- **Notion Migration**: Please refer to [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-<p>
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Install EdgeEver Web Clipper for Google Chrome" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Install EdgeEver Web Clipper for Microsoft Edge" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Install EdgeEver Web Clipper for Firefox" width="36" height="36" /></a>
-</p>
+### Native MCP Integration
+
+In **Profile** -> **API / MCP**, generate an API token and copy the Remote MCP configuration to allow AI Agents (Claude Code, Cursor, Antigravity, OpenClaw, etc.) to safely access your knowledge base. Agents can read and write text notes, diagrams, tables, and poster notes, as well as manage notebooks, tags, attachments, revisions, templates, and prompts.
-- **Smart Article Extraction**: Automatically extracts article content and converts it into clean Markdown, preserving the source URL and clipping timestamp.
-- **Selection & Context Menu Clipping**: Save selected text or right-clicked images directly as notes without capturing the entire page.
-- **Deep Social & Community Clipping**: Native structured clipping for 15+ major platforms including X (Twitter), Xiaohongshu, Zhihu, Reddit, GitHub, YouTube, and Bilibili.
-- **Private Self-Hosted Direct Connection**: Sends clipped content directly to your personal EdgeEver instance without third-party relays.
+> 💡 **Inspiration:**
+> Make AI your true knowledge orchestrator and creative co-pilot—instantly turn concepts into interactive mind maps, flowcharts, architecture diagrams, and structured tables, while supplying private context to your AI Agents. Paired with EdgeEver’s powerful rich-text editing and elegant typography, AI-assisted content becomes beautifully structured, polished, and publication-ready knowledge assets.
-## Community and Feedback
+### Multi-Account & Storage Analytics
-- Bugs, feature requests, and deployment issues: [GitHub Issues](https://github.com/tianma-if/edgeever/issues)
-- Code contributions: read the [Contribution Guide](CONTRIBUTING.md). If your Fork is also used to deploy EdgeEver, keep its `main` branch deployment-only. Create a separate branch from the official `upstream/main` for synchronization, development, and pull requests; do not develop on or Sync fork the deployment `main`.
+A deployed instance supports multiple user accounts. Administrators can manage accounts under **Profile** -> **Account Management**. Each user receives an isolated workspace, complete with notebooks, notes, attachments, trash, imports/exports, and MCP tokens. A storage analytics dashboard offers real-time visibility into overall and per-account attachment usage.
-### Telegram Community
+### Advanced Object Storage & Third-Party Image Hosting
+
+- **OSS Object Storage**: The instance owner can configure S3-compatible object storage under **Settings → Advanced → OSS object storage**. Changing storage does not migrate or affect existing attachments.
+- **Desktop PicGo Integration**: The desktop app optionally integrates with a local PicGo client service, uploading inserted images directly to GitHub, SM.MS, Upyun, Qiniu, or custom image hosts to minimize self-hosted storage and bandwidth consumption.
-Welcome to the EdgeEver community, bringing together developers and creators exploring vibe coding and AI. Join us to discuss cutting-edge AI productivity and best practices for personal knowledge bases.
+### Plugins & Themes
-👉 [Join the EdgeEver Telegram group](https://t.me/+wwUx1BYLrIdiZjY1)
+Web and desktop apps support functional plugins and custom themes installable with one click from the official marketplace, GitHub, or a manifest URL, syncing across your workspace. Developers can extend capabilities using `@edgeever/plugin-api`. See [Plugin Development](docs/plugin-development.md) and [Plugin Marketplace Policy](docs/plugin-marketplace-policy.md).
-## Plugins and Themes
+---
-Web and desktop apps support functional plugins and custom themes, installable from the official marketplace, GitHub, or a Manifest URL, with seamless sync across your workspace. Developers can extend capabilities using `@edgeever/plugin-api`; see the [plugin development guide](docs/plugin-development.md) and [marketplace submission policy](docs/plugin-marketplace-policy.md).
+## Developer Guide & Architecture
-## Tech Stack
+### Tech Stack
-- Bun workspace monorepo with Web, API, official site, and shared type package.
-- 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.
-- Android app: Expo + React Native in `apps/mobile`, with SQLite local storage and incremental sync.
-- iOS app: Native SwiftUI in `apps/ios` (iOS 17+), with a packaged TipTap EditorBundle, GRDB local mirror/outbox, and Android-aligned shell chrome.
-- Native desktop app: Electron + Rust sidecar combines a consistent cross-platform experience with high-performance local data services; SQLite enables offline editing, incremental sync when back online, and local backups.
-- Web clipper: Manifest V3, Mozilla Readability, and Turndown for Chrome, Microsoft Edge, and Firefox.
-- Backend: one Hono/Zod business application with REST API and Remote MCP; Cloudflare uses Workers/D1/R2, while Docker uses Bun/SQLite/local files or S3.
-- Official site: Astro static site in `apps/site`, deployable to Cloudflare Pages.
+- Bun workspace monorepo covering Web, API, site, and shared packages.
+- Frontend: Vite, React, React Router, TanStack Query; UI built with Tailwind CSS, shadcn/ui, and Radix UI.
+- Editor: TipTap / ProseMirror with Markdown support; PWA powered by vite-plugin-pwa, Workbox, and Dexie.
+- Android App: Expo + React Native in `apps/mobile` with SQLite local storage and incremental sync.
+- iOS App: Native SwiftUI (iOS 17+) in `apps/ios` with TipTap EditorBundle and GRDB local mirroring/outbox, aligned with the Android app shell.
+- Native Desktop: Electron + Rust sidecar balancing cross-platform consistency with high-performance local SQLite storage, offline editing, and incremental sync.
+- Web Clipper: Manifest V3, Mozilla Readability, and Turndown for Chrome, Microsoft Edge, and Firefox.
+- Backend: Hono/Zod application delivering REST API and Remote MCP; Cloudflare Workers/D1/R2, and Docker Bun/SQLite/local files or S3.
+- Site: Astro static site in `apps/site`, built independently and deployable to Cloudflare Pages.
-## Quick Start
+### Quick Start
```sh
bun install
bun run dev
```
-Local development signs in automatically; fresh databases use `owner` / `edgeever-local-dev`. Log out to test the login screen.
+Local development logs in automatically with `owner` / `edgeever-local-dev`. Log out manually to test the login screen.
-## Project Structure
+### Project Structure
```text
apps/web Vite + React frontend, PWA, offline drafts, and sync queue
-apps/extension Chrome/Edge/Firefox Manifest V3 web clipper
+apps/extension Chrome/Edge/Firefox Manifest V3 web clipper extension
apps/api Cloudflare Worker + Hono API, MCP endpoint
-apps/mobile Expo + React Native Android app
-apps/ios Native SwiftUI iOS app (TipTap EditorBundle, GRDB)
+apps/mobile Expo + React Native Android App
+apps/ios Native SwiftUI iOS App (TipTap EditorBundle, GRDB)
apps/desktop Electron desktop shell, preload bridge, and native packaging
-apps/site Astro official website, deployable independently
-packages/client Shared API client for web and mobile apps
-packages/shared Shared types, Zod schemas, TipTap / Markdown conversion
+apps/site Astro official website, independently deployable
+packages/client Shared API client for web and mobile
+packages/shared Shared types, Zod schemas, TipTap / Markdown converters
crates/desktop-sidecar
- Rust sidecar for local SQLite, offline data, backups, and resources
-scripts Wrangler wrapper, password hash, CLI, MCP stdio bridge, Evernote ENEX import
-migrations Shared append-only D1/SQLite database migrations
-docs Architecture, migration, and deployment docs
-.github/workflows CI for web, mobile, iOS, desktop packaging, deployment, and releases
-wrangler.toml Cloudflare Workers, Assets, D1, R2 configuration
+ Rust sidecar managing local SQLite, offline data, and backup
+scripts Wrangler wrappers, password hashing, CLI, MCP stdio bridge, ENEX import
+migrations Shared, append-only SQLite migrations for D1 and local setups
+docs Architecture, migration, and deployment guides
+.github/workflows CI for packaging, deployment, and releases
+wrangler.toml Cloudflare Workers, Assets, D1, and R2 configuration
```
-## Content Formats
+<details>
+<summary>⚙️ Architecture Design & Sync Implementation Details (Click to expand)</summary>
+
+#### Content Formats
-EdgeEver stores note content in three forms:
+EdgeEver stores three content representations simultaneously:
```text
-content_json TipTap/ProseMirror document, the editor source of truth
-content_markdown API, Agent, import, and export format
-content_text Search, summary, and indexing text
+content_json TipTap/ProseMirror document, the authoritative editor format
+content_markdown Used by APIs, AI Agents, imports, and exports
+content_text Used for search, summarization, and indexing
```
-Open **Profile** -> **Import and export** to export or import an EdgeEver ZIP. Its `notes/` directory is directly readable and portable as Markdown, while its structured data supports complete recovery between EdgeEver instances. Import preserves unrelated target data and overwrites records with matching EdgeEver IDs.
-
-## MCP
-
-Create an API token in **Profile** -> **API / MCP** and copy the Remote MCP configuration in one click to let AI Agents such as Claude Code, Cursor, Antigravity, and OpenClaw securely manage your knowledge base within account permissions. EdgeEver supports full CRUD for text notes, visual diagram notes (mind maps, flowcharts, and architecture diagrams), structured table notes, and native poster notes. Agents can also manage notebook hierarchies, tags, attachments, revision history, note templates, and AI instructions.
-
-> 💡 **Inspiration:**
-> Make AI your true knowledge orchestrator and creative co-pilot—instantly turn concepts into interactive mind maps, flowcharts, architecture diagrams, and structured tables, while supplying private context to your AI Agents. Paired with EdgeEver’s powerful rich-text editing and elegant typography, AI-assisted content becomes beautifully structured, polished, and publication-ready knowledge assets.
+Export or import EdgeEver ZIP files from **Profile** -> **Import & Export**. The `notes/` directory contains standard Markdown files for reading or migration, while structured data enables full restoration between EdgeEver instances. Existing data is preserved on import; matching IDs are updated.
-## Image Compression
+#### Image Compression
Image compression happens in the Web client before upload and is controlled by the **Compress note images** setting. When enabled, PNG, JPEG, WebP, and AVIF files are converted to WebP when beneficial, with the longest edge limited to `2560px`. If compression does not reduce size, the original file is kept.
EdgeEver avoids Worker-side image processing to reduce compute and image-processing quota usage. REST API and MCP upload paths store the file content provided by the client without additional server-side compression.
-## Advanced Object Storage & Third-Party Image Hosting
+#### Sync Timing
-- **OSS Object Storage**: The instance owner can configure S3-compatible object storage under **Settings → Advanced → OSS object storage**. Changing storage does not migrate or affect existing attachments.
-- **Desktop PicGo Integration**: The desktop app optionally integrates with a local PicGo client service, uploading inserted images directly to GitHub, SM.MS, Upyun, Qiniu, or custom image hosts to minimize self-hosted storage and bandwidth consumption.
-
-## Migration
-
-If you want to migrate notes from other platforms to EdgeEver, please refer to the following simple migration guides:
-
-- **Evernote Migration**: Please refer to [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
-- **flomo Migration**: Please refer to [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
-- **Memos Migration**: Please refer to [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
-- **Notion Migration**: Please refer to [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
+Web, PWA, and desktop upload memo edits after 30 seconds of inactivity and check for remote changes every 5 minutes while visible; focus and manual refresh remain immediate. Adjust `DEFERRED_MEMO_SYNC_DELAY_MS` and `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS` in [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts).
-## Docker Deployment
+</details>
-Docker runs the same frontend, API routes, services, authentication, MCP implementation, and migrations as Cloudflare. The container uses SQLite with local files or S3-compatible attachment storage and supports `amd64` and `arm64`. See [Deploy EdgeEver with Docker](docs/deploy-docker.md) and [Self-hosting and Docker architecture](docs/self-hosting-architecture.md).
+---
-## Sync Timing
+## Community & Feedback
-Web, PWA, and desktop upload memo edits after 30 seconds of inactivity and check for remote changes every 5 minutes while visible; focus and manual refresh remain immediate. Adjust `DEFERRED_MEMO_SYNC_DELAY_MS` and `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS` in [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts).
+- Please report bugs, suggest features, and ask deployment questions on [GitHub Issues](https://github.com/tianma-if/edgeever/issues) so other users can search and reference them.
+- Read [Contributing Guidelines](CONTRIBUTING.md) before submitting code. If your fork is used to deploy EdgeEver, keep `main` dedicated to deployment; branch from official `upstream/main` to develop and open PRs.
## Sponsor & Support
-EdgeEver is a free and open-source project. Sustaining cross-platform client development, continuous device testing, code signing, and multi-runtime ecosystem maintenance requires ongoing dedication and resources.
+EdgeEver is a free and open-source project. Sustaining client development across macOS, Windows, Linux, iOS, and Android, hardware testing, code-signing certificates, and multi-runtime architecture requires continuous resources.
-- [Support EdgeEver](docs/sponsor.md) — Voluntary donation via WeChat Pay or Alipay
-- [Sponsors & Partners](docs/partners.md) — Support infrastructure, developer tools, services, or community collaboration
+- [Support EdgeEver](docs/sponsor.md) — Donate via WeChat Pay or Alipay
+- [Sponsors & Partners](docs/partners.md) — Support infrastructure, tooling, or collaboration
## Acknowledgements
-- EdgeEver's note-taking product design was also informed by the publicly available product experiences of mature note-taking tools such as [Evernote](https://evernote.com/) and [Notion](https://www.notion.com/). The related features were independently designed and implemented by EdgeEver.
-- The product design of mind-map and visual-diagram notes was informed by the publicly available product experiences of [XMind](https://xmind.com/) and [ProcessOn](https://www.processon.com/). These features were independently designed and implemented by EdgeEver.
-- EdgeEver's poster design workspace draws inspiration from [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) by 向阳乔木 (joeseesun), and adapts its templates and typography engine under the MIT license.
-- The visual themes and typography of EdgeEver's image-sharing cards were inspired by [Firefly Card (流光卡片)](https://fireflycard.shushiai.com/). Thank you for the design inspiration.
+- Product design references public UX patterns from [Evernote](https://evernote.com/) and [Notion](https://www.notion.com/). All features are independently implemented by EdgeEver.
+- Diagramming notes reference design patterns from [XMind](https://xmind.com/) and [ProcessOn](https://www.processon.com/).
+- Poster canvas adapts templates and font engines from [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) by joeseesun under the MIT license.
+- Image card themes reference visual styling from [FireflyCard](https://fireflycard.shushiai.com/).
-## Trademark and Brand Use
+## Trademarks & Brand
-The EdgeEver name, logo, and other brand identifiers distinguish the official project. Forks and modified versions may state that they are based on EdgeEver, but must not imply official status or mislead users. The open-source license does not grant trademark rights; other uses require prior written permission from the project maintainers.
+The EdgeEver name, logo, and brand assets identify the official project. Forks and modifications may note they are "based on EdgeEver" but must not imply official affiliation. The open-source license does not grant trademark rights.
## Disclaimer
-EdgeEver is an independent open-source note-taking application developed and maintained by individuals and the community. It is not affiliated with, authorized, sponsored, or endorsed by Evernote Corporation or its affiliates.
+EdgeEver is an independent open-source project developed and maintained by the community. It is not affiliated with, sponsored by, or endorsed by Evernote Corporation or any commercial entities.
-EdgeEver is self-hosted software. Except for official demo instances, project maintainers do not host, control, or review user content. Content stored or displayed by an instance is the responsibility of its users or operators and does not represent the maintainers' views.
+EdgeEver is self-hosted software. Aside from the official demo, maintainers do not host, control, or review user content.
diff --git a/README.pl-PL.md b/README.pl-PL.md
index 3517eb8c..75f46cbc 100644
--- a/README.pl-PL.md
+++ b/README.pl-PL.md
@@ -19,9 +19,12 @@
<p>
<a href="https://t.me/+wwUx1BYLrIdiZjY1"><img src="assets/readme/community/telegram.svg" alt="Telegram" width="16" height="16" align="absmiddle" /> Grupa na Telegramie</a> &nbsp;|&nbsp;
<a href="https://demo.edgeever.org">🌐 Demo na żywo</a> &nbsp;|&nbsp;
- <a href="#pobierz-aplikacje">📱 Pobierz aplikacje</a> &nbsp;|&nbsp;
+ <a href="#aplikacje-i-rozszerzenia">📱 Aplikacje i rozszerzenia</a> &nbsp;|&nbsp;
<a href="#features">Najważniejsze funkcje i zastosowania</a>
</p>
+ <p>
+ <img src="assets/readme/hero.png" alt="EdgeEver: Trzypanelowy obszar roboczy i asystent AI" width="880" />
+ </p>
</div>
EdgeEver to nowoczesna, otwartoźródłowa przestrzeń do notatek i zarządzania wiedzą. Zachowuje wygodę klasycznego, wysoce efektywnego układu trzech paneli (drzewo katalogów · lista notatek · edytor), a jednocześnie daje kontrolę nad danymi i bezpośrednią współpracę z agentami AI.
@@ -35,10 +38,12 @@ EdgeEver to nowoczesna, otwartoźródłowa przestrzeń do notatek i zarządzania
Wielu użytkowników **aplikacji do notatek i osobistych baz wiedzy** szuka po prostu **niezawodnej, otwartej i szybkiej** osobistej bazy wiedzy. Popularne rozwiązania mają jednak swoje ograniczenia:
-* **Evernote**: Kiedyś oferowało najpłynniejszą i najbardziej bezproblemową synchronizację w chmurze między wieloma urządzeniami. Z czasem stało się jednak rozbudowanym komercyjnym pakietem: przybyło reklam i dodatków, wzrosło zużycie zasobów, ograniczono darmowy plan, a zaawansowane funkcje AI są kosztowne. Trudno też połączyć je z samodzielnie hostowanymi usługami i prywatnymi procesami AI.
-* **Obsidian**: Pliki są otwarte, ale sam program ma zamknięty kod. Oficjalna synchronizacja jest płatna, a konfiguracja innych metod wymaga pracy. Przy tysiącach notatek lub wielu wtyczkach skanowanie lokalnych plików spowalnia uruchamianie i wyszukiwanie. Obrazy i załączniki powiększają magazyn, utrudniają synchronizację mobilną i mogą pozostawać po usunięciu notatek.
-* **Memos i notatki strumieniowe**: Są proste, ale interfejs przypominający oś czasu różni się od uporządkowanej pracy w trzech panelach.
-* **SiYuan i systemy oparte na blokach**: Oferują wiele funkcji i własny hosting, lecz szczegółowa struktura bloków utrudnia szybkie zapisywanie myśli i pisanie dłuższego tekstu. Brakuje im również bezpłatnego wdrożenia bezserwerowego, a synchronizacja między urządzeniami wymaga płatnej subskrypcji lub dodatkowo płatnego dostępu do S3/WebDAV.
+| Typ rozwiązania | Przykładowe aplikacje | Układ i doświadczenie użytkownika | Synchronizacja i koszt hostingu | Ekosystem AI i agentów |
+| :--- | :--- | :--- | :--- | :--- |
+| **Komercyjne notatki w chmurze** | Evernote | Klasyczny układ 3 paneli, rozbudowany i ciężki | Ograniczany darmowy plan, drogi abonament | Zamknięty ekosystem, trudne połączenie z AI |
+| **Lokalne bazy Markdown** | Obsidian | Lokalne foldery i karty, opóźnienia przy dużej bazie | Zamknięty kod rdzenia, płatna synchronizacja | Zależność od wtyczek, brak natywnego MCP/ACP |
+| **Lekkie notatki / bazy blokowe** | Memos / SiYuan | Strumień kart lub architektura blokowa, wyższy próg | Wymaga własnego serwera lub płatnej subskrypcji | Skupienie na małych notatkach, brak pełnej wygody |
+| **Serverless baza wiedzy open source** | **EdgeEver** | **Klasyczne 3 panele + bogaty tekst i Markdown** | **Darmowy plan Cloudflare / Własny Docker** | **Natywny Remote MCP & integracja desktopowa ACP** |
**EdgeEver wypełnia tę lukę**: cały stos ma otwarty kod, zapewniając w pełni **płynną, błyskawiczną synchronizację w chmurze o niskim opóźnieniu między wieloma urządzeniami** oraz pełną swobodę bezpłatnego hostingu. Zachowuje znany układ trzech paneli, działa sprawnie nawet przy ponad 10 000 notatek i oferuje natywną współpracę z agentami AI oraz możliwość bezpłatnego wdrożenia.
@@ -48,7 +53,9 @@ Wielu użytkowników **aplikacji do notatek i osobistych baz wiedzy** szuka po p
Publiczne demo resetuje się codziennie o 3:00 czasu chińskiego (UTC+8) i przywraca przykładowe notatki. Nie zapisuj w nim prywatnych danych.
-## Pobierz aplikacje
+## Aplikacje i rozszerzenia
+
+### Pobierz aplikacje
<p>
<a href="https://github.com/tianma-if/edgeever/releases/latest"><img src="assets/readme/platforms/macos.svg" alt="Pobierz EdgeEver na macOS" width="40" height="40" /></a>&nbsp;&nbsp;
@@ -60,40 +67,61 @@ Publiczne demo resetuje się codziennie o 3:00 czasu chińskiego (UTC+8) i przyw
> Aplikacja na iOS wymaga Apple ID spoza Chin kontynentalnych.
+### Rozszerzenie Web Clipper do przeglądarek
+
+<p>
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Zainstaluj Web Clipper dla Google Chrome" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Zainstaluj Web Clipper dla Microsoft Edge" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Zainstaluj Web Clipper dla Firefoksa" width="36" height="36" /></a>
+</p>
+
+- **Inteligentne wyodrębnianie treści**: Automatycznie przekształca artykuły ze stron internetowych w czysty format Markdown, zachowując link źródłowy i czas zapisu.
+- **Zapisywanie zaznaczenia i menu kontekstowe**: Zaznacz fragment tekstu lub kliknij prawym przyciskiem myszy na obraz, aby natychmiast zapisać go jako notatkę.
+- **Wsparcie dla popularnych serwisów**: Zoptymalizowane reguły dla ponad 15 platform, m.in. X (Twitter), Xiaohongshu, Zhihu, Reddit, GitHub, Bilibili i YouTube.
+- **Prywatność i bezpośrednie połączenie**: Zapisane treści trafiają wprost do Twojej instancji, bez pośrednictwa zewnętrznych serwerów.
+
<a id="features"></a>
## Najważniejsze funkcje i zastosowania
EdgeEver łączy zbieranie materiałów z różnych źródeł, tworzenie treści wizualnych i współpracę w jednym środowisku:
-### Zapisywanie treści i przechowywanie plików
-- **Zapisywanie treści jednym kliknięciem na różnych platformach**: Rozszerzenie przeglądarki jest głęboko dostosowane do ponad 15 wiodących serwisów społecznościowych, forów i platform wideo, w tym [galerii Xiaohongshu](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping), [wpisów i cytatów z X (Twittera)](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping), [odpowiedzi z Zhihu](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping), [Reddita](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping), [GitHuba](docs/best-practices.md#8-one-click-github-repository-metadata-clipping), YouTube i Bilibili. Udostępnianie systemowe na telefonie pozwala szybko zapisać [zdjęcia](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes) i [artykuły z WeChat](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile).
-- **Archiwizacja rozmów WeChat**: Na macOS można zaimportować całą rozmowę przez „Forward to Other Apps → EdgeEver”, zachowując uczestników, znaczniki czasu, cytowane odpowiedzi i naklejki. Obrazy trafiają do notatki, a nagrania audio i wideo są zapisywane jako załączniki. Zobacz [przewodnik po archiwizacji rozmów](docs/best-practices.md#1-one-click-wechat-chat-history-archiving).
-- **Załączniki i kompresja obrazów po stronie klienta**: Dodawaj pliki PDF, dokumenty Office, archiwa i multimedia. Przesyłanie strumieniowe w częściach obsługuje załączniki do 1 GiB. Cicha kompresja obrazów w przeglądarce zmniejsza rozmiar zrzutów ekranu i dużych zdjęć o 50–90%, przyspieszając ładowanie i oszczędzając miejsce.
+### Zobacz kluczowe scenariusze w działaniu
+
+| 💡 Mapy myśli i diagramy generowane przez AI | 📊 Bazy wielowymiarowe AI i formularze online |
+| :---: | :---: |
+| <img src="docs/assets/best-practices/ai-diagram-mindmap.png" alt="Generowanie map myśli AI" width="420" /> | <img src="docs/assets/best-practices/ai-database-employee-roster.png" alt="Tworzenie tabel AI" width="420" /> |
+| **💬 Błyskawiczna archiwizacja rozmów WeChat** | **🎨 Kopiowanie stylizowanego tekstu do edytorów** |
+| <img src="docs/assets/best-practices/wechat-chat-imported-note.png" alt="Archiwizacja WeChat" width="420" /> | <img src="docs/assets/best-practices/copy-to-wechat-mp-menu.png" alt="Kopiowanie sformatowanego tekstu" width="420" /> |
-### Notatki wizualne i współpraca z bazami danych
-- **Diagramy i infografiki**: Poproś asystenta AI zwykłym językiem o interaktywne, edytowalne [mapy myśli, schematy blokowe lub diagramy architektury](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams). Zobacz [opis notatek z diagramami](docs/visual-diagram-notes.md); obsługiwane jest też renderowanie bloków Mermaid. Wbudowane szablony pozwalają tworzyć [infografiki, w tym osie czasu, porównania i wykresy kwadrantowe](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics).
-- **Wielowymiarowe tabele AI i publiczne formularze**: Na podstawie polecenia w języku naturalnym twórz [tabele do zarządzania projektami, treściami, zasobami i innymi procesami](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt), z odpowiednimi typami pól i przykładowymi rekordami. Jednym kliknięciem udostępnij [publiczny formularz](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables), który zbiera odpowiedzi bez logowania bezpośrednio do tabeli.
-- **Natywne notatki plakatowe i wizualny układ AI**: Natywne notatki plakatowe oparte na płótnie z bogatymi szablonami kart graficznych i dopracowanymi układami; kliknij dwukrotnie, aby edytować tekst lub zamienić obrazy i elementy zastępcze, z responsywnym powiększeniem jednym kliknięciem; asystenci AI oraz protokoły ACP i MCP mogą bezpośrednio tworzyć, interpretować i wspólnie dopracowywać zawartość plakatów.
-- **Dwa widoki edycji, organizacja przestrzeni i publiczna baza wiedzy**: Na komputerze przełączaj się między edytorem tekstu sformatowanego a źródłem Markdown. Korzystaj z trzech paneli z regulowaną szerokością, trybu skupienia, dowolnie zagnieżdżonych notatników, zbiorczego łączenia i przenoszenia notatek oraz sortowania przez przeciąganie. Dostępna jest historia wersji; oprócz udostępniania pojedynczych notatek z hasłem, publikuj **całe notatniki jako samodzielne witryny bazy wiedzy z drzewem nawigacji** i ochroną hasłem.
+### 1. Zapisywanie treści i przechowywanie plików
+- **Zapisywanie treści jednym kliknięciem**: Rozszerzenie wspiera m.in. [Xiaohongshu](docs/best-practices.md#2-one-click-xiaohongshu-red-note-clipping), [X (Twitter)](docs/best-practices.md#3-one-click-x-twitter-post--quote-clipping), [Zhihu](docs/best-practices.md#4-one-click-zhihu-answer--column-article-clipping), [Reddit](docs/best-practices.md#5-one-click-reddit-discussion-post-clipping), [GitHub](docs/best-practices.md#8-one-click-github-repository-metadata-clipping), YouTube i Bilibili; udostępnianie systemowe zapisuje [zdjęcia](docs/best-practices.md#9-one-click-mobile-image-sharing-to-notes) oraz [artykuły](docs/best-practices.md#10-one-click-wechat-article-clipping-on-mobile).
+- **Archiwizacja rozmów WeChat**: Pełny import na macOS z zachowaniem uczestników, znaczników czasu, obrazów i załączników. Zobacz [instrukcję archiwizacji](docs/best-practices.md#1-one-click-wechat-chat-history-archiving).
+- **Załączniki i kompresja obrazów**: Obsługa plików do 1 GiB; cicha kompresja w przeglądarce zmniejsza obrazy o 50–90%.
-### Publikowanie i udostępnianie
-- **WeChat Official Account i kopiowanie ze stylami**: Twórz tekst sformatowany ze stylami CSS i [kopiuj notatki jednym kliknięciem do edytora WeChat Official Account](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs), newsletterów lub blogów.
-- **Grafiki z notatek i eksport**: Zamień notatkę w [estetyczną grafikę do udostępniania](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing) jednym kliknięciem, wybierając spośród dopracowanych motywów wizualnych, awatarów monogramowych, adaptacyjnej typografii i układów. Pojedyncze notatki można eksportować do Markdown, HTML lub PDF.
-- **Codzienne podsumowania RSS tworzone przez AI**: Oficjalna wtyczka subskrypcji RSS zbiera wpisy z kanałów i blogów, filtruje szum przy użyciu AI i przygotowuje zwięzłe notatki z podsumowaniem dnia.
+### 2. Notatki wizualne i współpraca z bazami danych
+- **Diagramy i infografiki**: Proś asystenta AI o edytowalne [mapy myśli i schematy blokowe](docs/best-practices.md#11-ai-conversational-generation-of-mind-maps-flowcharts--architecture-diagrams) (zobacz [opis](docs/visual-diagram-notes.md)); twórz profesjonalne [infografiki](docs/best-practices.md#12-ai-powered-generation-of-professional-infographics).
+- **Wielowymiarowe tabele AI i formularze**: Twórz [tabele procesowe](docs/best-practices.md#13-instant-multi-dimensional-database-table-generation-via-ai-prompt) poleceniem w języku naturalnym; publikuj [formularze online bez logowania](docs/best-practices.md#14-one-click-public-online-form-collection-from-database-tables).
+- **Natywne notatki plakatowe i wizualny układ AI**: Notatki plakatowe oparte na płótnie z bogatymi szablonami i wsparciem asystenta AI.
+- **Dwa widoki edycji i publikacja bazy wiedzy**: Przełączaj się między bogatym tekstem a Markdownem; publikuj **całe notatniki jako samodzielne witryny z drzewem nawigacji**.
-### Natywni agenci AI i otwarty ekosystem
-- **Protokoły MCP i ACP**: Wbudowany Model Context Protocol (MCP) pozwala zewnętrznym agentom AI czytać i porządkować notatki. Aplikacja desktopowa używa Agent Client Protocol (ACP), aby współpracować bezpośrednio z lokalnymi agentami, takimi jak Codex, Antigravity, Claude Code i WorkBuddy.
-- **Własne modele AI i API wtyczek**: Podłącz wielu dostawców zgodnych z OpenAI, Anthropic lub Gemini oraz własne serwery pośredniczące. AI może streszczać, wydobywać informacje, sprawdzać tekst, tłumaczyć i wspierać redakcję. Możliwości aplikacji rozszerzysz przez [API tworzenia wtyczek](docs/plugin-development.md).
+### 3. Publikowanie i udostępnianie
+- **Kopiowanie ze stylami**: Przekształcaj notatki w estetyczny format i [kopiuj jednym kliknięciem](docs/best-practices.md#6-one-click-note-copy-to-wechat-official-account--blogs) do newsletterów i edytorów.
+- **Grafiki z notatek i eksport**: Zamień notatkę w [grafikę plakatową](docs/best-practices.md#7-ai-rss-daily-digest--elegant-image-poster-sharing); eksportuj do Markdown, HTML lub PDF.
+- **Codzienne podsumowania RSS tworzone przez AI**: Oficjalna wtyczka RSS filtruje szum informacyjny i przygotowuje zwięzłe podsumowania.
-### Otwarta architektura, wiele platform i bezpieczeństwo
-- **Elastyczne wdrożenie i kontrola nad danymi**: Korzystaj z darmowego planu Cloudflare (około 150 tys. krótkich notatek i 50 tys. obrazów) albo wdróż aplikację przez Dockera na VPS, NAS lub serwerze domowym, aby przechowywać miliony notatek. Standardowa baza SQLite, REST API, narzędzia CLI i bezstratny eksport oraz import pełnego archiwum ZIP pomagają zachować niezależność danych.
-- **Wiele platform i ochrona środowiska produkcyjnego**: Oficjalne aplikacje działają w [przeglądarce, na Androidzie](https://play.google.com/store/apps/details?id=org.edgeever.mobile&hl=pl), [macOS](https://github.com/tianma-if/edgeever/releases), [Windows](https://github.com/tianma-if/edgeever/releases/latest), [Linuksie](https://github.com/tianma-if/edgeever/releases/latest) i [iOS](https://apps.apple.com/pl/app/edgeever/id6792625631). Rozszerzenie Web Clipper jest dostępne dla [Chrome](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo), [Edge](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo) i [Firefox](https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/). Synchronizacja we własnym środowisku nie ogranicza liczby urządzeń; aplikacja desktopowa ma niewielkie zużycie pamięci, a dostępne są wersje robocze offline, kolejki synchronizacji, ochrona serwera przed atakami siłowymi i odizolowane przestrzenie użytkowników.
+### 4. Natywni agenci AI i otwarty ekosystem
+- **Protokoły MCP i ACP**: Wbudowany protokół MCP umożliwia bezpieczny dostęp agentom zewnętrznym; wersja desktopowa współpracuje przez ACP z lokalnymi agentami (Codex, Antigravity, Claude Code itp.).
+- **Własne modele AI i API wtyczek**: Podłącz dostawców zgodnych z OpenAI, Anthropic, Gemini; twórz rozszerzenia przez [API wtyczek](docs/plugin-development.md).
+
+### 5. Otwarta architektura, wiele platform i bezpieczeństwo
+- **Elastyczne wdrożenie i kontrola nad danymi**: Działa na Cloudflare (darmowy limit do ~150 tys. notatek) lub przez Dockera; standardowa baza SQLite i pełny eksport ZIP.
+- **Wiele platform i ochrona produkcyjna**: Oficjalne aplikacje na Web, Android, iOS, macOS, Windows, Linux i przeglądarki; wersje robocze offline i ochrona przed atakami siłowymi.
👉 Wszystkie 14 scenariuszy ze zrzutami ekranu opisuje [pełny przewodnik po funkcjach i zastosowaniach](docs/best-practices.md).
## Wdrożenie
-Cloudflare to zalecana opcja bez własnego serwera. Docker jest dostępny dla osób korzystających z VPS, NAS lub serwera domowego. Szczegółowe przewodniki wdrożenia są obecnie dostępne po angielsku.
+Cloudflare to zalecana opcja bez własnego serwera. Docker jest dostępny dla osób korzystających z VPS, NAS lub serwera domowego.
W przypadku Cloudflare wybierz jedną z poniższych metod wdrożenia online:
@@ -123,13 +151,16 @@ Wdróż EdgeEver przez GitHub i Cloudflare:
### Opcja B: Ręczne wdrożenie online
+<details>
+<summary>📖 Rozwiń: 6 kroków konfiguracji ręcznej w przeglądarce</summary>
+
Konfiguracja obejmuje sześć kroków w interfejsie przeglądarkowym:
1. **Utwórz Fork repozytorium**: Kliknij **Fork** w prawym górnym rogu strony GitHub, aby utworzyć kopię EdgeEver na swoim koncie.
2. **Utwórz zasoby Cloudflare**: Utwórz bazę D1 `edgeever` i zasobnik R2 `edgeever-resources`.
3. **Zaimportuj i skonfiguruj projekt**: W Cloudflare **Workers & Pages** utwórz Worker `edgeever` z gałęzi `main` swojego Forka. Użyj katalogu głównego repozytorium i zachowaj domyślne polecenie wdrożenia Workers Builds. Token API musi mieć prawo do odczytu i modyfikacji D1. Polecenie wdrożenia utworzy powiązania zasobów; nie edytuj plików Forka.
4. **Wybierz hasło administratora**: Ustaw hasło, najlepiej o długości co najmniej 32 znaków. Po utworzeniu Workera zapisz je jako sekret środowiska uruchomieniowego `EDGE_EVER_AUTH_PASSWORD`.
-5. **Zbuduj i sprawdź aplikację**: **Save and Deploy** tworzy Workera i uruchamia build. Jeśli zakończy się błędem z powodu braku sekretu administratora, dodaj sekret z kroku 4 i ponów próbę. Domyślna nazwa użytkownika to `admin`; aby ją zmienić, ustaw zmienną Workers Builds `EDGE_EVER_AUTH_USERNAME` przed ponownym buildem. Po wdrożeniu sprawdź, czy `/api/health` zwraca `200`, i zaloguj się.
+5. **Zbuduj i sprawdź aplikację**: Save and Deploy tworzy instancję Workera i rozpoczyna build. Pierwsza próba służy głównie zainicjowaniu zasobów; błąd z powodu braku hasła administratora jest oczekiwanym zjawiskiem. Wystarczy dodać sekret środowiska `EDGE_EVER_AUTH_PASSWORD` z kroku 4 i ponowić build. Domyślna nazwa to `admin`; inną można ustawić zmienną Workers Builds `EDGE_EVER_AUTH_USERNAME`. Po wdrożeniu sprawdź `/api/health` (powinno zwrócić `200`) i zaloguj się.
6. **Włącz automatyczne aktualizacje**: W zakładce **Actions** Forka kliknij **I understand my workflows, go ahead and enable them**, a następnie ręcznie uruchom raz workflow **Update deployed EdgeEver**.
> Pełne instrukcje i konfigurację znajdziesz w [przewodniku wdrożenia online](docs/deploy-cloudflare-button.md).
@@ -138,163 +169,153 @@ Konfiguracja obejmuje sześć kroków w interfejsie przeglądarkowym:
> 💡 **Aktywacja Cloudflare R2**: Choć [darmowy limit przestrzeni R2](https://developers.cloudflare.com/r2/pricing/#free-tier) wystarcza na typowe notatki, najpierw trzeba aktywować subskrypcję R2 i dodać metodę płatności. Cloudflare [obsługuje](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) karty UnionPay, Visa i Mastercard oraz PayPal, Apple Pay i Google Pay.
-### Opcja C: Docker na VPS lub NAS
+</details>
+
+### Opcja C: Wdrożenie z Dockerem na VPS lub NAS
+
+Docker i Cloudflare korzystają z tego samego kodu frontendu, API, logiki, uwierzytelniania, implementacji MCP i migracji bazy danych. Kontener używa bazy SQLite i obsługuje lokalne pliki lub załączniki w S3, oferując obrazy dla `amd64` i `arm64`. Zobacz [wdrożenie z Dockerem](docs/deploy-docker.md) i [architekturę self-hosting](docs/self-hosting-architecture.md).
-Użyj instalatora hostowanego w GitHubie i oficjalnego obrazu GHCR:
+Uruchom oficjalny skrypt instalacyjny z obrazem z GHCR:
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
-Polecenie pobiera najnowszy obraz, generuje hasło administratora i uruchamia EdgeEver przez Docker Compose.
+Polecenie pobierze najnowszy obraz, wygeneruje hasło i uruchomi EdgeEver przez Docker Compose. Domyślnie włączone są codzienne aktualizacje; aby zaktualizować ręcznie, uruchom `~/edgeever/update.sh` na serwerze.
-Ręczne wdrożenie i konfigurację opisuje [przewodnik po Dockerze](docs/deploy-docker.md).
-
-Po instalacji aktualizacje domyślnie uruchamiają się codziennie. Aby zaktualizować aplikację ręcznie, uruchom `~/edgeever/update.sh` na serwerze.
+> 💡 **Wskazówka sieciowa**: Oficjalny obraz znajduje się w GitHub Container Registry (GHCR). Jeśli pobieranie przebiega powoli, skonfiguruj serwer proxy lub zaufane zwierciadło.
---
-## Logowanie wielu użytkowników i zużycie miejsca
+## Migracja danych i zaawansowana konfiguracja
-Jedna instancja obsługuje wiele kont. Administrator może tworzyć i wyłączać konta oraz resetować ich hasła w **Profil → Członkowie**. Każdy użytkownik otrzymuje odizolowaną przestrzeń z notatnikami, notatkami, załącznikami, Koszem, importem i eksportem oraz tokenami MCP. Przejrzysty panel zużycia miejsca pozwala na bieżąco monitorować przestrzeń zajmowaną przez załączniki w całej instancji i na poszczególnych kontach.
+### Migracja (Migration)
-## Rozszerzenie Web Clipper
+Jeśli chcesz przenieść notatki z innych aplikacji do EdgeEver, skorzystaj z poniższych prostych przewodników:
-<p>
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="Zainstaluj EdgeEver Web Clipper w Chrome" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="Zainstaluj EdgeEver Web Clipper w Edge" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://addons.mozilla.org/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="Zainstaluj EdgeEver Web Clipper w Firefoxie" width="36" height="36" /></a>
-</p>
+- **Migracja z Evernote**: Zobacz [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
+- **Migracja z flomo**: Zobacz [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
+- **Migracja z Memos**: Zobacz [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
+- **Migracja z Notion**: Zobacz [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-- **Wydobywanie treści artykułów**: Rozszerzenie pobiera tekst i przekształca go w przejrzysty Markdown, zachowując adres źródłowy oraz czas zapisania.
-- **Zapisywanie zaznaczenia i obrazów z menu kontekstowego**: Dodawaj zaznaczony tekst lub obraz wskazany prawym przyciskiem myszy bez przechwytywania całej strony.
-- **Głęboka integracja z platformami społecznościowymi i forami**: Dedykowane, ustrukturyzowane zapisywanie treści z ponad 15 wiodących platform, w tym X (Twittera), Xiaohongshu, Zhihu, Reddita, GitHuba, YouTube i Bilibili.
-- **Bezpośrednie prywatne połączenie**: Rozszerzenie wysyła materiały do Twojej instancji EdgeEver bez pośrednictwa zewnętrznych usług.
+### Natywna integracja MCP
-## Społeczność i opinie
+W menu **Profil** -> **API / MCP** wygeneruj token API i skopiuj konfigurację Remote MCP, aby agenci AI (Claude Code, Cursor, Antigravity, OpenClaw itp.) mogli bezpiecznie zarządzać bazą wiedzy. Agenci mogą odczytywać i modyfikować notatki tekstowe, diagramy, tabele i plakaty, a także zarządzać notatnikami, tagami, załącznikami, historią wersji i szablonami.
-- Błędy, propozycje funkcji i problemy z wdrożeniem zgłaszaj przez [GitHub Issues](https://github.com/tianma-if/edgeever/issues).
-- Przed wniesieniem zmian przeczytaj [poradnik współtworzenia](CONTRIBUTING.md). Jeśli Twój Fork służy również do wdrożenia EdgeEver, pozostaw jego gałąź `main` wyłącznie do wdrożeń. Do synchronizacji, prac rozwojowych i pull requestów utwórz osobną gałąź od oficjalnego `upstream/main`; nie rozwijaj aplikacji ani nie używaj opcji Sync fork na wdrożeniowej gałęzi `main`.
+> 💡 **Inspiracja:**
+> Zmień AI w swojego prawdziwego organizatora wiedzy i partnera w twórczości — przekształcaj pomysły w mapy myśli, schematy blokowe i uporządkowane tabele, dostarczając prywatnego kontekstu agentom AI.
+
+### Wiele kont i analityka pamięci
+
+Pojedyncza instancja pozwala na logowanie wielu użytkowników. Administrator może zarządzać kontami w **Profil** -> **Zarządzanie kontami**. Każdy użytkownik otrzymuje całkowicie odizolowaną przestrzeń. Panel zużycia pamięci pozwala na bieżąco kontrolować zajętość dysku.
+
+### Magazyn obiektowy OSS i integracja z PicGo
-### Społeczność na Telegramie
+- **Magazyn obiektowy OSS**: Właściciel instancji może skonfigurować magazyn zgodny z S3 w **Ustawienia → Zaawansowane → Magazyn obiektowy OSS**. Zmiana nie wpływa na istniejące załączniki.
+- **Integracja z PicGo na komputerze**: Aplikacja desktopowa może opcjonalnie przesyłać obrazy przez lokalnego klienta PicGo na zewnętrzne hostingi, oszczędzając przestrzeń dyskową instancji.
-Zapraszamy do społeczności EdgeEver, skupiającej twórców i pasjonatów vibe codingu oraz AI. Rozmawiajmy o nowoczesnej produktywności opartej na AI i sprawdzonych praktykach budowania osobistej bazy wiedzy.
+### Wtyczki i motywy
-👉 [Dołącz do grupy na Telegramie](https://t.me/+wwUx1BYLrIdiZjY1)
+Aplikacje webowe i desktopowe obsługują wtyczki i motywy instalowane jednym kliknięciem z oficjalnego katalogu, GitHuba lub adresu manifestu. Programiści mogą tworzyć własne rozszerzenia przy użyciu `@edgeever/plugin-api`. Zobacz [przewodnik po tworzeniu wtyczek](docs/plugin-development.md) i [zasady katalogu wtyczek](docs/plugin-marketplace-policy.md).
-## Wtyczki i motywy
+---
-Aplikacje Web i desktopowa obsługują wtyczki oraz własne motywy, instalowane z oficjalnego marketplace, GitHuba lub adresu manifestu i synchronizowane między urządzeniami. Programiści mogą rozszerzać aplikację przez `@edgeever/plugin-api`; zobacz [przewodnik tworzenia wtyczek](docs/plugin-development.md) i [zasady publikowania w marketplace](docs/plugin-marketplace-policy.md).
+## Przewodnik programisty i architektura
-## Stos technologiczny
+### Stos technologiczny
-- Monorepo oparte na Bun z aplikacją Web, API, oficjalną stroną i pakietem współdzielonych typów.
-- Interfejs: Vite, React, React Router, TanStack Query, Tailwind CSS, shadcn/ui i Radix UI.
-- Edytor: TipTap / ProseMirror z obsługą Markdown; PWA korzysta z vite-plugin-pwa, Workbox i Dexie.
-- Android: Expo + React Native w `apps/mobile`, lokalny SQLite i synchronizacja przyrostowa.
-- iOS: natywny SwiftUI w `apps/ios` (iOS 17+), dołączony EditorBundle TipTap, lokalna kopia i kolejka zmian GRDB.
-- Desktop: Electron + proces pomocniczy Rust, SQLite do edycji offline, synchronizacji przyrostowej i lokalnych kopii zapasowych.
-- Web Clipper: Manifest V3, Mozilla Readability i Turndown dla Chrome, Edge i Firefox.
-- Backend: jedna aplikacja biznesowa Hono/Zod z REST API i Remote MCP. Cloudflare używa Workers/D1/R2, a Docker używa Bun/SQLite oraz plików lokalnych lub S3.
-- Oficjalna strona: statyczna witryna Astro w `apps/site`, wdrażana niezależnie na Cloudflare Pages.
+- Monorepo oparte na Bun, zawierające aplikację Web, API, witrynę oraz pakiety współdzielone.
+- Frontend: Vite, React, React Router, TanStack Query; UI oparty na Tailwind CSS, shadcn/ui i Radix UI.
+- Edytor: TipTap / ProseMirror z obsługą Markdown; PWA z vite-plugin-pwa, Workbox i Dexie.
+- Aplikacja Android: Expo + React Native w `apps/mobile` z bazą SQLite i synchronizacją przyrostową.
+- Aplikacja iOS: Natywny SwiftUI (iOS 17+) w `apps/ios` z TipTap EditorBundle i lokalnym GRDB.
+- Aplikacja desktopowa: Electron + sidecar w Rust, zapewniający spójność i wysoką wydajność bazy SQLite w trybie offline.
+- Web Clipper: Manifest V3, Mozilla Readability i Turndown dla Chrome, Microsoft Edge i Firefoksa.
+- Backend: Aplikacja Hono/Zod z REST API i Remote MCP; Cloudflare Workers/D1/R2 lub Docker Bun/SQLite.
+- Witryna: Statyczna strona Astro w `apps/site`.
-## Szybki start
+### Szybki start
```sh
bun install
bun run dev
```
-W lokalnym środowisku deweloperskim logowanie następuje automatycznie. Nowa baza używa danych `owner` / `edgeever-local-dev`. Wyloguj się, aby sprawdzić ekran logowania.
+W środowisku deweloperskim automatycznie logowane jest konto `owner` / `edgeever-local-dev`.
-## Struktura projektu
+### Struktura katalogów
```text
-apps/web Interfejs Vite + React, PWA, wersje robocze offline i kolejka synchronizacji
-apps/extension Rozszerzenie Web Clipper Manifest V3 dla Chrome/Edge/Firefox
-apps/api Cloudflare Worker + Hono API, punkt końcowy MCP
-apps/mobile Aplikacja Android Expo + React Native
-apps/ios Natywna aplikacja iOS SwiftUI (EditorBundle TipTap, GRDB)
-apps/desktop Powłoka Electron, most preload i pakowanie aplikacji
-apps/site Oficjalna strona Astro, wdrażana niezależnie
-packages/client Współdzielony klient API dla aplikacji Web i mobilnej
-packages/shared Współdzielone typy, schematy Zod, konwersja TipTap / Markdown
+apps/web Frontend Vite + React, PWA, wersje robocze offline i kolejka synchronizacji
+apps/extension Rozszerzenie Manifest V3 do wycinania treści z sieci
+apps/api API Hono na Cloudflare Worker, punkt końcowy MCP
+apps/mobile Aplikacja na Androida (Expo + React Native)
+apps/ios Natywna aplikacja na iOS w SwiftUI (TipTap EditorBundle, GRDB)
+apps/desktop Powłoka Electron, mostek preload i konfiguracja pakietów
+apps/site Oficjalna strona w Astro
+packages/client Współdzielony klient API dla wersji webowej i mobilnej
+packages/shared Współdzielone typy, schematy Zod, konwertery TipTap / Markdown
crates/desktop-sidecar
- Proces pomocniczy Rust dla lokalnego SQLite, pracy offline, kopii i plików
-scripts Wrapper Wrangler, haszowanie haseł, CLI, most MCP stdio, import Evernote ENEX
-migrations Wspólne migracje D1/SQLite dopisywane bez zmiany wcześniejszych plików
-docs Dokumentacja architektury, migracji i wdrażania
-.github/workflows CI dla Web, mobile, iOS, pakietów desktopowych, wdrożeń i wydań
-wrangler.toml Konfiguracja Cloudflare Workers, Assets, D1 i R2
+ Sidecar w Rust obsługujący lokalną bazę SQLite i dane offline
+scripts Skrypty pomocnicze, Wrangler, haszowanie, CLI, mostek MCP stdio, import ENEX
+migrations Wspólne migracje SQLite dla D1 i instancji lokalnych
+docs Dokumentacja architektury, migracji i wdrożeń
+.github/workflows CI/CD dla budowania, testowania i wydań
+wrangler.toml Konfiguracja Workers, Assets, D1 i R2
```
-## Formaty treści
+<details>
+<summary>⚙️ Szczegóły architektury i synchronizacji (kliknij, aby rozwinąć)</summary>
+
+#### Formaty treści
-Treść notatki jest przechowywana w trzech postaciach:
+EdgeEver zapisuje treść w trzech formatach równolegle:
```text
-content_json Dokument TipTap/ProseMirror, główne źródło dla edytora
-content_markdown Format API, agentów, importu i eksportu
-content_text Tekst do wyszukiwania, podsumowań i indeksowania
+content_json Dokument TipTap/ProseMirror, format nadrzędny edytora
+content_markdown Używany przez API, agentów AI oraz podczas importu i eksportu
+content_text Używany do wyszukiwania, podsumowań i indeksowania
```
-W **Profil → Import i eksport** można wyeksportować lub zaimportować archiwum ZIP EdgeEver. Katalog `notes/` zawiera czytelne pliki Markdown, a dane strukturalne pozwalają całkowicie odtworzyć instancję. Import zachowuje niezwiązane dane w instancji docelowej i nadpisuje rekordy o tych samych identyfikatorach EdgeEver.
-
-## MCP
-
-Utwórz token API w **Profil → API / MCP** i skopiuj konfigurację Remote MCP jednym kliknięciem. Agenci AI, tacy jak Claude Code, Cursor, Antigravity i OpenClaw, będą mogli bezpiecznie zarządzać Twoją bazą wiedzy w zakresie uprawnień konta. EdgeEver obsługuje pełne tworzenie, odczyt, edycję i usuwanie notatek tekstowych, diagramów (map myśli, schematów blokowych i diagramów architektury), tabel strukturalnych oraz natywnych notatek plakatowych. Agenci mogą też zarządzać strukturą notatników, tagami, załącznikami, historią wersji, szablonami i instrukcjami AI.
+Pliki ZIP EdgeEver można eksportować lub importować w **Profil** -> **Import i eksport**. Katalog `notes/` zawiera pliki Markdown, a dane strukturalne pozwalają na pełne przywrócenie bazy w nowej instancji.
-> 💡 **Inspiracja:**
-> Użyj AI jako pomocnika w porządkowaniu wiedzy: zamieniaj pomysły w interaktywne mapy myśli, diagramy i tabele, dostarczając agentom własny kontekst. Edytor tekstu sformatowanego i typografia EdgeEver pomagają dopracować wynik do postaci gotowej do publikacji.
-
-## Kompresja obrazów
-
-Obrazy są kompresowane przed przesłaniem w aplikacji Web; steruje tym ustawienie **Kompresuj obrazy w notatkach**. Po włączeniu pliki PNG, JPEG, WebP i AVIF są konwertowane na WebP, jeśli zmniejsza to ich rozmiar. Najdłuższy bok jest ograniczony do `2560px`. Gdy kompresja nie daje oszczędności, aplikacja zachowuje oryginał.
-
-EdgeEver nie przetwarza obrazów po stronie Workera, co ogranicza zużycie zasobów obliczeniowych i limitów przetwarzania. Przesyłanie przez REST API i MCP przechowuje plik otrzymany od klienta bez dodatkowej kompresji na serwerze.
+#### Zasady kompresji obrazów
-## Zaawansowane przechowywanie plików i zewnętrzny hosting obrazów
+Kompresja obrazów odbywa się w przeglądarce przed wysłaniem na serwer i jest sterowana opcją „Kompresuj obrazy w notatkach”. Gdy opcja jest włączona, formaty PNG, JPEG, WebP i AVIF są konwertowane do WebP, a dłuższy bok jest ograniczany do `2560px`. Jeśli plik po kompresji nie jest mniejszy, zachowywany jest oryginał.
-- **Magazyn obiektów OSS**: Właściciel instancji może skonfigurować magazyn zgodny z S3 w **Profil → Zaawansowane → Magazyn obiektów OSS**. Zmiana magazynu nie przenosi istniejących załączników ani ich nie modyfikuje.
-- **Integracja z PicGo na komputerze**: Aplikacja desktopowa opcjonalnie współpracuje z lokalną usługą PicGo, przesyłając wstawiane obrazy bezpośrednio do GitHuba, SM.MS, Upyun, Qiniu lub własnego hostingu, co ogranicza zużycie miejsca i transferu we własnym środowisku.
+#### Czas synchronizacji
-## Migracja
+Wersje Web, PWA i desktop przesyłają zmiany po 30 sekundach bezczynności i sprawdzają zmiany w chmurze co 5 minut, gdy okno jest aktywne. Przywrócenie ostrości okna wyzwala natychmiastowe odświeżenie. Czas można dostosować w pliku [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts).
-Jeśli chcesz przenieść notatki z innej aplikacji do EdgeEver, skorzystaj z poniższych przewodników (obecnie po angielsku):
+</details>
-- **Evernote**: [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
-- **flomo**: [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
-- **Memos**: [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
-- **Notion**: [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-
-## Wdrożenie przez Dockera
-
-Wariant Docker używa tego samego interfejsu, tras API, usług, uwierzytelniania, implementacji MCP i migracji co Cloudflare. Kontener korzysta z SQLite oraz plików lokalnych lub magazynu zgodnego z S3 i obsługuje architektury `amd64` oraz `arm64`. Zobacz [wdrożenie EdgeEver przez Dockera](docs/deploy-docker.md) oraz [architekturę własnego hostingu](docs/self-hosting-architecture.md).
+---
-## Czas synchronizacji
+## Społeczność i opinie
-Aplikacje Web, PWA i desktopowa przesyłają zmiany notatek po 30 sekundach bezczynności i sprawdzają zmiany zdalne co 5 minut, gdy są widoczne. Ponowne przejście do aplikacji i ręczne odświeżenie działają od razu. Parametry `DEFERRED_MEMO_SYNC_DELAY_MS` i `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS` znajdują się w [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts).
+- Błędy, propozycje funkcji i pytania dotyczące wdrożenia zgłaszaj w [GitHub Issues](https://github.com/tianma-if/edgeever/issues).
+- Przed przesłaniem kodu zapoznaj się z [zasadami kontrybucji](CONTRIBUTING.md).
## Wsparcie projektu
-EdgeEver jest darmowym projektem o otwartym kodzie. Rozwijanie aplikacji na różne platformy, testy na urządzeniach, podpisywanie kodu i utrzymywanie kilku środowisk uruchomieniowych wymagają czasu i środków.
+EdgeEver to darmowy projekt open source. Rozwój aplikacji na wiele platform, testy na fizycznym sprzęcie, podpisywanie kodu i rozwój środowisk wymagają czasu i zasobów.
-- [Wesprzyj EdgeEver](docs/sponsor.md) — dobrowolne wpłaty przez WeChat Pay lub Alipay.
-- [Sponsorzy i partnerzy](docs/partners.md) — wsparcie infrastruktury, narzędzi, usług i współpracy ze społecznością.
+- [Wesprzyj EdgeEver](docs/sponsor.md)
+- [Sponsorzy i partnerzy](docs/partners.md)
## Podziękowania
-- Przy projektowaniu EdgeEver wzorowano się na publicznie dostępnych rozwiązaniach dojrzałych aplikacji do notatek, takich jak [Evernote](https://evernote.com/) i [Notion](https://www.notion.com/). Powiązane funkcje zostały zaprojektowane i zaimplementowane niezależnie przez EdgeEver.
-- Inspiracją dla notatek z mapami myśli i diagramami były publicznie dostępne funkcje [XMind](https://xmind.com/) i [ProcessOn](https://www.processon.com/). Funkcje te zostały zaprojektowane i zaimplementowane niezależnie przez EdgeEver.
-- Narzędzie do projektowania plakatów w EdgeEver czerpie inspirację z [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) autorstwa 向阳乔木 (joeseesun) i wykorzystuje dostosowane szablony oraz silnik typograficzny udostępnione na licencji MIT.
-- Motywy wizualne i typografia kart do udostępniania notatek jako obrazów w EdgeEver były inspirowane [Firefly Card (流光卡片)](https://fireflycard.shushiai.com/). Dziękujemy za inspirację projektową.
+- Projekt bazuje na publicznych wzorcach UX aplikacji [Evernote](https://evernote.com/) i [Notion](https://www.notion.com/).
+- Notatki z diagramami czerpią inspirację z [XMind](https://xmind.com/) i [ProcessOn](https://www.processon.com/).
+- Układ plakatów bazuje na projekcie [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design) autorstwa joeseesun (licencja MIT).
+- Szablony kart graficznych nawiązują do stylu [FireflyCard](https://fireflycard.shushiai.com/).
-## Znak towarowy i użycie marki
+## Znaki towarowe i marka
-Nazwa EdgeEver, logo i inne elementy identyfikacji wyróżniają oficjalny projekt. Forki i zmodyfikowane wersje mogą informować, że bazują na EdgeEver, ale nie mogą sugerować oficjalnego statusu ani wprowadzać użytkowników w błąd. Licencja otwartego oprogramowania nie przyznaje praw do znaków towarowych; ich inne użycie wymaga uprzedniej pisemnej zgody opiekunów projektu.
+Nazwa, logo i elementy marki EdgeEver służą identyfikacji oficjalnego projektu. Wersje pochodne mogą informować o opieraniu się na EdgeEver, lecz nie mogą sugerować oficjalnego statusu.
-## Zastrzeżenie
+## Zastrzeżenie prawne
-EdgeEver to niezależna, otwartoźródłowa aplikacja do notatek rozwijana przez osoby prywatne i społeczność. Projekt nie jest powiązany z Evernote Corporation ani jej podmiotami zależnymi, nie jest przez nie autoryzowany, sponsorowany ani popierany.
+EdgeEver to niezależne oprogramowanie open source rozwijane przez społeczność. Projekt nie jest powiązany z firmą Evernote Corporation ani sponsorowany przez nią.
-EdgeEver jest oprogramowaniem do samodzielnego hostingu. Poza oficjalnymi instancjami demonstracyjnymi opiekunowie projektu nie hostują, nie kontrolują ani nie przeglądają treści użytkowników. Za treść przechowywaną lub wyświetlaną przez instancję odpowiadają jej użytkownicy lub operatorzy; nie reprezentuje ona poglądów opiekunów projektu.
+EdgeEver to oprogramowanie do samodzielnego hostingu. Poza oficjalną wersją demonstracyjną twórcy projektu nie przechowują, nie kontrolują ani nie moderują treści użytkowników.
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 94a298dd..23fcb96c 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -19,13 +19,14 @@
<p>
<a href="#wechat-group"><img src="assets/readme/community/wechat.svg" alt="WeChat" width="16" height="16" align="absmiddle" /> 微信交流群</a> &nbsp;|&nbsp;
<a href="https://demo.edgeever.org">🌐 在线演示</a> &nbsp;|&nbsp;
- <a href="#客户端下载">📱 客户端下载</a> &nbsp;|&nbsp;
+ <a href="#全平台客户端与浏览器插件">📱 客户端与插件下载</a> &nbsp;|&nbsp;
<a href="#features">核心特性与场景</a>
</p>
+ <p>
+ <img src="assets/readme/hero.png" alt="EdgeEver 三栏工作台与 AI 伴侣界面" width="880" />
+ </p>
</div>
-
-
EdgeEver 是一款现代化的开源笔记与个人知识库工作区。它保留经典高效的三栏工作区体验(目录树 · 笔记列表 · 编辑写作),同时具备完全开放的数据架构与原生 AI Agent 联动能力,让个人知识沉淀更轻量、更自由。
> 💡 **终身免服务器,100% 免费**
@@ -35,12 +36,14 @@ EdgeEver 是一款现代化的开源笔记与个人知识库工作区。它保
## 为什么做 EdgeEver
-很多**笔记与个人知识库**的用户,核心需求只是一个**可靠、开放、响应迅速**的个人知识库。然而,当下的主流方案都各有痛点:
+很多**笔记与个人知识库**的用户,核心需求只是一个**可靠、开放、响应迅速**的个人知识库。主流方案各有侧重与取舍:
-* **印象笔记**:曾拥有最无感、最丝滑的多端云同步体验。然而随着它演进为全功能商业套件,广告与附加功能渐多,系统开销也随之走高;加之免费版配额收紧、高级 AI 订阅昂贵,且难以灵活接入现代自托管与私有 AI 工作流。
-* **Obsidian**:Markdown 开放,核心闭源;官方同步收费,第三方同步繁琐;纯本地文件依赖遍历扫描,当笔记积累到数千上万条或加载复杂插件后,冷启动与全库检索明显卡顿迟缓;图片与附件与文本混存,仓库体积极易膨胀导致移动端同步缓慢,且删笔记后残留附件难清理;对于“随时随地随手记”的轻量场景来说偏重。
-* **Memos / Flomo 等轻量笔记**:虽然简单好用,但流式卡片布局与习惯了经典“三栏工作流”的用户有着天然的交互习惯差异。
-* **思源笔记等块级知识库**:功能深厚且支持开源自托管,但全面的“块级(Block)”架构使得日常随手记录与连续排版书写的心智负担偏重;且缺少零服务器成本的 Serverless 部署形态,多端同步主要依赖官方付费订阅,或需额外付费解锁 S3/WebDAV 同步特性并自备存储。
+| 方案类型 | 代表产品 | 布局与交互体验 | 同步机制与自托管成本 | AI 与 Agent 扩展生态 |
+| :--- | :--- | :--- | :--- | :--- |
+| **传统商业云笔记** | 印象笔记 / Evernote | 经典三栏布局,功能逐渐膨胀重型化 | 免费额度收紧,高级商业订阅昂贵 | 商业封闭生态,难以接入私有 AI 工作流 |
+| **本地文件双链库** | Obsidian | 本地文件夹与标签页,海量笔记检索易卡顿 | 核心代码闭源,官方同步收费,附件混存易膨胀 | 依赖社区插件,缺乏原生云端与 Agent 协议 |
+| **轻量卡片 / 块级知识库** | Memos / 思源笔记 | 流式卡片或全面块级架构,书写心智负担偏重 | 需自备服务器,或依赖官方订阅与付费解锁同步 | 侧重单点记录,难以兼顾长文与原生 Agent 协同 |
+| **Serverless 全栈开源知识库** | **EdgeEver** | **经典三栏工作区 + 富文本与 Markdown 双视图** | **Cloudflare 零成本免维托管 / Docker 本地自建** | **原生内置 Remote MCP & 桌面端 ACP 深度互联** |
**EdgeEver 恰好填补了这一空白**:整栈开源,提供真正**零感知、低延迟的多端瞬时云同步**,且全部服务均可免费自托管;同时保留经典三栏布局与流畅排版,万条笔记常驻依然轻盈丝滑,原生支持接入 AI Agent,部署维护零门槛、零费用。
@@ -50,7 +53,9 @@ EdgeEver 是一款现代化的开源笔记与个人知识库工作区。它保
公开演示环境会在每天凌晨 3:00(北京时间)自动重置并恢复示例笔记,请不要保存私密内容。
-## 客户端下载
+## 全平台客户端与浏览器插件
+
+### 客户端下载
<p>
<a href="https://github.com/tianma-if/edgeever/releases/latest"><img src="assets/readme/platforms/macos.svg" alt="下载 macOS 客户端" width="40" height="40" /></a>&nbsp;&nbsp;
@@ -62,34 +67,55 @@ EdgeEver 是一款现代化的开源笔记与个人知识库工作区。它保
> iOS 客户端需要使用非中国大陆区 Apple ID 下载。
+### 浏览器网页裁剪插件
+
+<p>
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="为 Google Chrome 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="为 Microsoft Edge 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://addons.mozilla.org/zh-CN/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="为 Firefox 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>
+</p>
+
+- **智能正文提取**:自动提取网页文章正文并转为纯净 Markdown,自动保留来源网址与剪藏时间。
+- **划选与右键剪藏**:选中局部文字或右键任意图片直接存为独立笔记,无需抓取整页冗余内容。
+- **社媒与社区深度剪藏**:深度适配 X (Twitter)、小红书、知乎、Reddit、GitHub、Bilibili、YouTube 等十余个主流平台,一键结构化入库。
+- **自托管隐私直连**:剪藏内容直传个人自托管实例,不经过任何第三方服务器中转。
+
<a id="features"></a>
## 核心特性与场景
从跨渠道内容捕获到深度知识表达与业务协作,EdgeEver 为个人与团队提供了高效流畅的端到端工作流:
-### 全渠道剪藏与多媒体沉淀
-- **跨平台一键剪藏**:浏览器插件深度适配 [小红书画廊](docs/best-practices.zh-CN.md#2-小红书图文笔记一键剪藏)、[X (Twitter) 推文与引用](docs/best-practices.zh-CN.md#3-x-twitter-推文与引用一键剪藏)、[知乎问答](docs/best-practices.zh-CN.md#4-知乎回答与文章一键精准剪藏)、[Reddit](docs/best-practices.zh-CN.md#5-reddit-讨论帖一键剪藏)、[GitHub](docs/best-practices.zh-CN.md#8-github-开源仓库信息一键剪藏) 以及 Bilibili、YouTube、小宇宙等十余个主流社媒与音视频平台;手机端通过系统分享一键转存[全网图片](docs/best-practices.zh-CN.md#9-移动端社媒图片一键转存笔记)与[微信公众号文章](docs/best-practices.zh-CN.md#10-手机端一键剪藏微信公众号文章)。
-- **微信聊天记录完整归档**:macOS 端支持在微信中将聊天记录「转发到其他应用 → EdgeEver」,一键整段导入为结构化笔记,完整保留发言人、时间轴、引用回复及微信表情,图片自动内嵌,视频与文件自动转为笔记附件。详见[微信聊天记录一键归档与整理](docs/best-practices.zh-CN.md#1-微信聊天记录一键归档与整理)。
-- **通用文件附件与端侧图片压缩**:支持轻松上传并插入 PDF、Office 文档、压缩包及音视频等各种附件,分片上传与流式处理安全支持最大 1 GiB 附件;图片上传前在浏览器端静默完成压缩,常见截图与大图精简 50%-90% 体积,加载更迅速、存储更省心。
+### 精选核心场景实机预览
-### 智能可视化与多维数据协作
-- **全类型可视化图表与专业信息图**:告别外部绘图软件,借助伴随式 AI 助手自然语言一句话生成可交互编辑的[思维导图、流程图与架构图](docs/best-practices.zh-CN.md#11-ai-对话一键生成思维导图流程图与架构图)(详见[可视化图表笔记设计说明](docs/visual-diagram-notes.zh-CN.md),原生支持 Mermaid 代码块渲染);内置丰富模板库,一键生成精美专业的[全类型可视化信息图(时间线、对比图、象限矩阵等)](docs/best-practices.zh-CN.md#12-ai-智能生成专业信息图时间线对比图架构图等)。
-- **AI 多维表格与在线收集表单**:自然语言一句话按需搭建[任意业务场景多维表格](docs/best-practices.zh-CN.md#13-借助右侧-ai-助手一句话生成多维表格)(如项目管理、选题库、人事资产等),自动推断单选标签、日期等字段类型并预置真实示例数据;支持一键开启无需登录的[对外公开在线收集表单](docs/best-practices.zh-CN.md#14-多维表格一键生成在线公开收集表单),用户填报数据实时沉淀入库。
-- **原生海报笔记与 AI 视觉排版**:原生支持基于画布的结构化海报笔记,内置丰富的图文卡片模板与排版布局;支持双击编辑文案、替换图片与占位符,支持一键自适应缩放;伴随式 AI 助手与 ACP / MCP 协议可直接理解、生成并协同精修海报内容。
-- **双视图编辑、空间组织与知识库公开发布**:桌面端支持在富文本与 Markdown 源码视图之间自由切换;经典三栏布局与可调节面板宽度、一键专注模式与无限层级笔记本,支持笔记批量合并/移动与拖拽排序;提供自动版本回溯;除单篇笔记加密分享外,更支持**将整个笔记本一键公开发布为带目录树导航的独立知识库网站**,并提供访问密码保护。
+| 💡 AI 一键生成思维导图与架构图 | 📊 AI 业务多维表格与在线收集表单 |
+| :---: | :---: |
+| <img src="docs/assets/best-practices/ai-diagram-mindmap.png" alt="AI 一键生成思维导图" width="420" /> | <img src="docs/assets/best-practices/ai-database-employee-roster.png" alt="AI 一键搭建多维表格" width="420" /> |
+| **💬 微信聊天记录一键整段结构化归档** | **🎨 微信公众号一键排版与内联格式复制** |
+| <img src="docs/assets/best-practices/wechat-chat-imported-note.png" alt="微信聊天记录归档" width="420" /> | <img src="docs/assets/best-practices/copy-to-wechat-mp-menu.png" alt="微信公众号排版复制" width="420" /> |
-### 创作者排版与一键分发
-- **微信公众号一键排版与复制**:专为中文创作者设计,支持将笔记一键转换为带行内样式的公众号美化格式,[一键复制内联富文本到微信公众号](docs/best-practices.zh-CN.md#6-一键复制笔记到微信公众号排版)后台直接粘贴发布,告别第三方排版工具。
-- **高颜值长图分享与多格式导出**:任意笔记均可一键[分享为精美长图海报](docs/best-practices.zh-CN.md#7-ai-rss-智能订阅日报与精美长图分享),内置多款质感主题、Monogram 字母头像、自适应排版、自定义字体与卡片版式,优雅分发至社交媒体;支持单篇笔记独立便捷导出为 Markdown、HTML 或 PDF。
-- **AI RSS 智能订阅日报**:内置官方 AI RSS 订阅插件,自动定时聚合行业资讯与博客源,AI 过滤噪音并生成结构严谨、重点清晰的精炼日报笔记。
+### 1. 全渠道剪藏与多媒体沉淀
+- **跨平台一键剪藏**:插件深度适配 [小红书](docs/best-practices.zh-CN.md#2-小红书图文笔记一键剪藏)、[X (Twitter)](docs/best-practices.zh-CN.md#3-x-twitter-推文与引用一键剪藏)、[知乎](docs/best-practices.zh-CN.md#4-知乎回答与文章一键精准剪藏)、[Reddit](docs/best-practices.zh-CN.md#5-reddit-讨论帖一键剪藏)、[GitHub](docs/best-practices.zh-CN.md#8-github-开源仓库信息一键剪藏)、B站及 YouTube;手机端支持[全网图片](docs/best-practices.zh-CN.md#9-移动端社媒图片一键转存笔记)与[公众号文章一键剪藏](docs/best-practices.zh-CN.md#10-手机端一键剪藏微信公众号文章)。
+- **微信聊天记录完整归档**:macOS 端支持微信一键转发整段对话导入笔记,完整保留时间轴、头像、表情、附件与图片,详见[微信归档说明](docs/best-practices.zh-CN.md#1-微信聊天记录一键归档与整理)。
+- **通用文件附件与端侧图片压缩**:支持各类音视频与办公文件(流式分片最高 1 GiB);浏览器端静默智能压缩图片,节省 50%-90% 存储。
-### 原生 AI Agent 与开放生态
-- **原生 Agent 协议深度互联(MCP & ACP)**:内置 MCP(Model Context Protocol)协议,支持外部 AI Agent 直接读取与整理笔记;桌面端支持通过 ACP(Agent Client Protocol)协议直接调用本机运行的 AI Agent(如 Codex、Antigravity、Claude Code、WorkBuddy 等)协同创作。
-- **接入自有模型与开放插件 API**:支持添加多个 OpenAI、Anthropic、Gemini 兼容服务与第三方中转平台,在伴侣侧边栏与编辑器中随时对全文或选区进行智能总结、提炼、翻译与润色;提供丰富的[插件开发 API](docs/plugin-development.zh-CN.md)自由扩展功能。
+### 2. 智能可视化与多维数据协作
+- **全类型可视化图表与专业信息图**:AI 一句话直接生成可编辑的[思维导图、流程图与架构图](docs/best-practices.zh-CN.md#11-ai-对话一键生成思维导图流程图与架构图)(详见[图表笔记设计](docs/visual-diagram-notes.zh-CN.md));内置模板一键生成[时间线、对比图等信息图](docs/best-practices.zh-CN.md#12-ai-智能生成专业信息图时间线对比图架构图等)。
+- **AI 多维表格与在线收集表单**:自然语言一键搭建[任意业务场景多维表格](docs/best-practices.zh-CN.md#13-借助右侧-ai-助手一句话生成多维表格),自动推断字段与示例数据;支持一键生成免登录[对外在线收集表单](docs/best-practices.zh-CN.md#14-多维表格一键生成在线公开收集表单)。
+- **原生海报笔记与 AI 视觉排版**:内置结构化图文卡片模板与排版画布,支持双击编辑、替换素材与一键自适应缩放,AI 助手可直接协同生成。
+- **双视图编辑与知识库公开发布**:支持富文本与 Markdown 源码自由切换;提供经典三栏无限层级树、版本回溯,以及**整本笔记本一键公开发布为带目录树的独立网站**。
-### 开放架构、全端体验与安全基座
-- **自由部署与数据无围墙**:既可免费运行于 Cloudflare Serverless(个人免费额度约容纳 15 万条短笔记与 5 万张图片),也可通过 Docker 部署到 VPS、NAS 或家庭服务器(轻松承载百万级笔记与海量图片);基于标准 SQLite 存储,提供 REST API、CLI 接口与无损 ZIP 档案导出导入,数据完全自主不设围墙。
-- **全平台覆盖与稳定安全**:官方覆盖 Web、[Android](https://play.google.com/store/apps/details?id=org.edgeever.mobile)、[macOS](https://github.com/tianma-if/edgeever/releases)、[Windows](https://github.com/tianma-if/edgeever/releases/latest)、[Linux](https://github.com/tianma-if/edgeever/releases/latest) 及 [iOS](https://apps.apple.com/us/app/edgeever/id6792625631)(网页裁剪插件支持 [Chrome](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo)、[Edge](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo) 和 [Firefox](https://addons.mozilla.org/zh-CN/firefox/addon/edgeever-web-clipper/)),自托管多端同步无设备数量限制;桌面端轻快省内存,支持离线草稿与同步队列、服务端防暴力破解限流保护,以及多账号空间数据隔离。
+### 3. 创作者排版与一键分发
+- **微信公众号一键排版与复制**:专为创作者打造,笔记一键转换为带内联样式的公众号格式,[一键复制内联富文本](docs/best-practices.zh-CN.md#6-一键复制笔记到微信公众号排版)到后台直接发布。
+- **高颜值长图分享与多格式导出**:任意笔记一键[生成精美长图海报](docs/best-practices.zh-CN.md#7-ai-rss-智能订阅日报与精美长图分享),内置多套质感排版;支持导出 Markdown、HTML 与 PDF。
+- **AI RSS 智能订阅日报**:内置 AI RSS 插件,自动定时抓取资讯与博客,AI 过滤噪音并生成精炼日报。
+
+### 4. 原生 AI Agent 与开放生态
+- **原生 Agent 协议互联(MCP & ACP)**:内置 MCP 协议供外部 AI Agent 安全读写管理知识库;桌面端通过 ACP 协议直接调动本机 Agent(Codex、Claude Code、Antigravity 等)协同创作。
+- **接入自有模型与开放插件 API**:支持接入 OpenAI、Anthropic、Gemini 兼容服务,在侧边栏随时进行总结与翻译;提供丰富的[插件开发 API](docs/plugin-development.zh-CN.md)。
+
+### 5. 开放架构、全端体验与安全基座
+- **自由部署与数据无围墙**:支持 Cloudflare Serverless 零成本托管(免费额度约容纳 15 万条笔记)或 Docker 本地部署(承载百万级笔记与海量图片);标准 SQLite 存储,支持无损 ZIP 导入导出。
+- **全平台覆盖与稳定安全**:官方覆盖 Web、Android、iOS、macOS、Windows、Linux 与主流浏览器插件,多端同步无设备数量限制;支持离线草稿、同步队列与防爆破限流。
👉 查看全部 14 个实机演示与操作效果:**[完整场景与最佳实践指南](docs/best-practices.zh-CN.md)**
@@ -123,13 +149,16 @@ Cloudflare 在线部署可以选择以下两种方式之一:
### 方案二:手动在线部署
+<details>
+<summary>📖 展开查看:网页端 6 步手动部署流程</summary>
+
仅需在网页端完成 6 步配置:
1. **Fork 仓库**:在 GitHub 点击右上角 **Fork**,将项目 Fork 到您的个人账户下。
2. **创建 Cloudflare 资源**:创建 D1 `edgeever` 与 R2 `edgeever-resources`。
3. **导入并配置项目**:在 Cloudflare **Workers & Pages** 中从 Fork 的 `main` 分支创建名为 `edgeever` 的 Worker。使用仓库根目录,保留由 Cloudflare 在线执行的 Workers Builds 默认部署命令,并确认其 API Token 具备 D1 读取和编辑权限。binding 由部署命令生成,不要修改 Fork 中的文件。
4. **准备管理员密码**:准备管理员登录密码,建议至少 32 个字符。Worker 创建后,将它保存为运行时 Secret `EDGE_EVER_AUTH_PASSWORD`。
-5. **首次构建与验证**:保存并部署会创建 Worker 并启动构建。如因缺少管理员 Secret 而失败,添加第 4 步的运行时 Secret 后重试。管理员用户名默认为 `admin`;如需使用其他用户名,请在重试构建前设置 Workers Builds 构建变量 `EDGE_EVER_AUTH_USERNAME`。部署完成后访问 `/api/health`,确认返回 `200`,再用配置的管理员用户名和密码登录。
+5. **首次构建与验证**:保存并部署会创建 Worker 并启动构建。首次构建主要用于初始化实例,若因尚未配置管理员 Secret 而报错属于预期行为,只需在第 4 步添加运行时 Secret `EDGE_EVER_AUTH_PASSWORD` 后点击重试构建即可通过。管理员用户名默认为 `admin`;如需使用其他用户名,请在重试构建前设置 Workers Builds 构建变量 `EDGE_EVER_AUTH_USERNAME`。部署完成后访问 `/api/health`,确认返回 `200`,再用配置的管理员用户名和密码登录。
6. **启用自动更新**:进入 Fork 的 **Actions** 标签页,点击 **I understand my workflows, go ahead and enable them**,然后手动运行一次 **Update deployed EdgeEver**,确保后续能够自动获得正式版本的功能更新与修复。
> 📖 包含具体参数与构建命令的详细步骤,请查看 [在线部署完整文档](docs/deploy-cloudflare-button.zh-CN.md)。
@@ -138,63 +167,60 @@ Cloudflare 在线部署可以选择以下两种方式之一:
> 💡 **Cloudflare R2 开通**:虽然 Cloudflare R2 存储提供了足够慷慨、在笔记场景中完全不会超量的[免费存储额度](https://developers.cloudflare.com/r2/pricing/#free-tier),但需先开通 R2 subscription 并绑定付款方式。Cloudflare [官方支持](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) 银联(UnionPay)、Visa、Mastercard 等银行卡,以及 PayPal、Apple Pay、Google Pay 等付款方式。
+</details>
+
### 方案三:在 VPS 或 NAS 上使用 Docker
+Docker 与 Cloudflare 共用同一套前端、API 路由、业务服务、鉴权、MCP 实现和 migration。容器使用 SQLite,并支持本地文件或 S3 兼容附件存储,提供 `amd64` 与 `arm64` 镜像。详见[使用 Docker 部署 EdgeEver](docs/deploy-docker.zh-CN.md)和[自托管与 Docker 架构](docs/self-hosting-architecture.zh-CN.md)。
+
使用 GitHub 托管的安装脚本和官方 GHCR 镜像:
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
-该命令会自动拉取最新镜像、生成管理员密码,并使用 Docker Compose 启动 EdgeEver。手动部署与配置说明见 [Docker 部署文档](docs/deploy-docker.zh-CN.md)。
-
-安装后默认每日自动更新。如需手动更新,请在部署服务器上运行 `~/edgeever/update.sh`。
+该命令会自动拉取最新镜像、生成管理员密码,并使用 Docker Compose 启动 EdgeEver。安装后默认每日自动更新;如需手动更新,请在部署服务器上运行 `~/edgeever/update.sh`。
> 💡 **网络提示**:官方镜像托管于 GitHub(GHCR)。若在部分网络环境下遇到拉取缓慢或超时,请在部署前自行配置可用的网络代理或可信的镜像加速服务。
---
-## 多账号登录与存储用量
+## 数据迁移与进阶使用
-部署完成后,单个实例支持多账号登录。
+### 导入与迁移 (Migration)
-实例管理员可以在 **个人中心** -> **账号管理** 中创建、停用成员账号或重置密码。每个成员拥有完全隔离的个人空间,包括笔记本、笔记、附件、回收站、导入导出和 MCP Token 等。系统同时提供直观的存储用量面板,可实时掌握实例整体与各账号的附件存储占用明细。
+如果你想从其他笔记软件迁移到 EdgeEver,请参考以下极简迁移指引:
-## 浏览器网页裁剪插件
+- **印象笔记(Evernote)的迁入**:请参考 [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
+- **flomo 笔记的迁入**:请参考 [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
+- **Memos 笔记的迁入**:请参考 [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
+- **Notion 笔记的迁入**:请参考 [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-<p>
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="为 Google Chrome 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="为 Microsoft Edge 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://addons.mozilla.org/zh-CN/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="为 Firefox 安装 EdgeEver 网页裁剪插件" width="36" height="36" /></a>
-</p>
+### MCP 原生集成
-- **智能正文提取**:自动提取网页文章正文并转为纯净 Markdown,自动保留来源网址与剪藏时间。
-- **划选与右键剪藏**:选中局部文字或右键任意图片直接存为独立笔记,无需抓取整页冗余内容。
-- **社媒与社区深度剪藏**:深度适配 X (Twitter)、小红书、知乎、Reddit、GitHub、Bilibili、YouTube 等十余个主流社媒、技术社区与音视频平台,一键结构化入库。
-- **自托管隐私直连**:剪藏内容直传个人自托管实例,不经过任何第三方服务器中转。
+在 **个人中心** -> **API / MCP** 中创建 API Token 并一键复制 Remote MCP 配置,即可让 Claude Code、Cursor、Antigravity、OpenClaw 等 AI Agent 在账号授权范围内安全管理你的知识库。系统支持文本笔记、图表笔记(思维导图、流程图与架构图)、多维表格笔记与原生海报笔记的完整增删改查,Agent 还可管理笔记本目录、标签、附件、历史版本、笔记模板与 AI 指令。
-## 社区与反馈
+> 💡 **场景启发:**
+> 让 AI 真正成为你的知识管家与创作外脑——不仅能将方案秒级生成为可交互的思维导图、流程图、架构图与多维表格,还能为 AI Agent 提供私有知识上下文。依托 EdgeEver 强大的富文本编辑与精美排版能力,AI 协同沉淀的不再是冰冷文本,而是结构工整、排版优雅、随时可一键分发的高品质知识资产。
-- Bug、功能建议和部署问题请优先提交 [GitHub Issues](https://github.com/tianma-if/edgeever/issues),方便后续用户检索和复用解决方案。
-- 贡献代码前请阅读[贡献代码须知](CONTRIBUTING.zh-CN.md)。如果您的 Fork 同时用于部署 EdgeEver,请将 `main` 分支仅用于部署;从官方 `upstream/main` 新建独立分支,在该分支中同步上游、开发并提交 Pull Request,不要在部署用的 `main` 上开发或执行 Sync fork。
+### 多账号登录与存储用量
-<hr>
+部署完成后,单个实例支持多账号登录。实例管理员可以在 **个人中心** -> **账号管理** 中创建、停用成员账号或重置密码。每个成员拥有完全隔离的个人空间,包括笔记本、笔记、附件、回收站、导入导出和 MCP Token 等。系统同时提供直观的存储用量面板,可实时掌握实例整体与各账号的附件存储占用明细。
-<h3 id="wechat-group">微信交流群</h3>
+### 高级对象存储与第三方图床
-欢迎加入 EdgeEver AI 交流群,这里聚集了大量 Vibe Coding 与 AI 玩家。一起交流前沿 AI 生产力与个人知识库的最佳实践。
+- **OSS 对象存储**:实例 Owner 可在**设置 → 高级设置 → OSS 对象存储**中配置兼容 S3 API 的对象存储。切换存储不会迁移或影响已有附件。
+- **桌面端 PicGo 图床**:桌面端支持可选接入本机 PicGo 客户端服务,在笔记中插入图片时可直接上传至 GitHub、SM.MS、又拍云、七牛云或自建图床,进一步减少自托管实例的存储开销与流量占用。
-> 扫描下方二维码或添加微信 `m1245207870`(备注“EdgeEver 进群”),群主将手动邀请入群。
+### 插件与主题
-<p align="center">
- <img src="assets/wechat-group-qr.jpg" alt="微信联系人二维码" width="260" />
-</p>
+Web 与桌面端支持功能插件与个性化主题,可从官方市场、GitHub 或 Manifest 地址一键安装,并随工作区跨端同步。开发者可使用 `@edgeever/plugin-api` 扩展能力,详见[插件开发文档](docs/plugin-development.zh-CN.md)与[官方插件市场上架政策](docs/plugin-marketplace-policy.zh-CN.md)。
-## 插件与主题
+---
-Web 与桌面端支持功能插件与个性化主题,可从官方市场、GitHub 或 Manifest 地址一键安装,并随工作区跨端同步。开发者可使用 `@edgeever/plugin-api` 扩展能力,详见[插件开发文档](docs/plugin-development.zh-CN.md)与[官方插件市场上架政策](docs/plugin-marketplace-policy.zh-CN.md)。
+## 开发者指南与架构
-## 技术栈
+### 技术栈
- Bun workspace monorepo,包含 Web、API、官网与共享类型包。
- 前端:Vite、React、React Router、TanStack Query,UI 基于 Tailwind CSS、shadcn/ui、Radix UI。
@@ -206,7 +232,7 @@ Web 与桌面端支持功能插件与个性化主题,可从官方市场、GitH
- 后端:一套基于 Hono/Zod 的业务应用,提供 REST API 与 Remote MCP;Cloudflare 使用 Workers/D1/R2,Docker 使用 Bun/SQLite/本地文件或 S3。
- 官网:Astro 静态站点,位于 `apps/site`,可独立构建并部署到 Cloudflare Pages。
-## 快速开始
+### 快速开始
```sh
bun install
@@ -215,7 +241,7 @@ bun run dev
本地开发默认自动登录,首次账号为 `owner` / `edgeever-local-dev`;测试登录页可主动退出登录。
-## 目录结构
+### 目录结构
```text
apps/web Vite + React 前端、PWA、离线草稿与同步队列
@@ -236,7 +262,10 @@ docs 架构、迁移与部署文档
wrangler.toml Cloudflare Workers、Assets、D1、R2 配置
```
-## 内容格式
+<details>
+<summary>⚙️ 架构设计与同步实现细节(点击展开)</summary>
+
+#### 内容格式
EdgeEver 同时保存三种内容形态:
@@ -248,39 +277,36 @@ content_text 搜索、摘要和索引使用
请打开 **我的** -> **导入与导出**,导出或导入 EdgeEver ZIP。压缩包中的 `notes/` 目录可直接作为 Markdown 阅读和迁移,结构化数据则用于在 EdgeEver 实例之间完整恢复;导入时目标实例中的无关数据会保留,相同 EdgeEver ID 的内容会被覆盖。
-## MCP
-
-在 **个人中心** -> **API / MCP** 中创建 API Token 并一键复制 Remote MCP 配置,即可让 Claude Code、Cursor、Antigravity、OpenClaw 等 AI Agent 在账号授权范围内安全管理你的知识库。系统支持文本笔记、图表笔记(思维导图、流程图与架构图)、多维表格笔记与原生海报笔记的完整增删改查,Agent 还可管理笔记本目录、标签、附件、历史版本、笔记模板与 AI 指令。
-
-> 💡 **场景启发:**
-> 让 AI 真正成为你的知识管家与创作外脑——不仅能将方案秒级生成为可交互的思维导图、流程图、架构图与多维表格,还能为 AI Agent 提供私有知识上下文。依托 EdgeEver 强大的富文本编辑与精美排版能力,AI 协同沉淀的不再是冰冷文本,而是结构工整、排版优雅、随时可一键分发的高品质知识资产。
-
-## 图片压缩规则
+#### 图片压缩规则
图片压缩仅在 Web 端上传前执行,由设置页的“压缩笔记内图片”开关控制。启用后,浏览器会把 PNG、JPEG、WebP、AVIF 尝试压缩为 WebP,并将最长边限制在 `2560px` 以内;如果压缩结果不比原图小,则保留原图。
Cloudflare Worker 侧执行图片处理会消耗计算/图片处理额度,因此 EdgeEver 将图片压缩放在 Web 客户端完成;REST API 或 MCP 上传入口会按客户端提供的文件内容直接入库,不再由服务端自动压缩。
-## 高级对象存储与第三方图床
+#### 同步时序
-- **OSS 对象存储**:实例 Owner 可在**设置 → 高级设置 → OSS 对象存储**中配置兼容 S3 API 的对象存储。切换存储不会迁移或影响已有附件。
-- **桌面端 PicGo 图床**:桌面端支持可选接入本机 PicGo 客户端服务,在笔记中插入图片时可直接上传至 GitHub、SM.MS、又拍云、七牛云或自建图床,进一步减少自托管实例的存储开销与流量占用。
+Web、PWA 与桌面端会在停止编辑 30 秒后上传笔记,并在页面可见时每 5 分钟检查云端变更;窗口聚焦与手动刷新仍会立即拉取。可在 [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) 中调整 `DEFERRED_MEMO_SYNC_DELAY_MS` 和 `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS`。
-## 导入与迁移 (Migration)
+</details>
-如果你想从其他笔记软件迁移到 EdgeEver,请参考以下极简迁移指引:
+---
-- **印象笔记(Evernote)的迁入**:请参考 [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
-- **Memos 笔记的迁入**:请参考 [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
-- **Notion 笔记的迁入**:请参考 [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
+## 社区与反馈
-## Docker 部署
+- Bug、功能建议和部署问题请优先提交 [GitHub Issues](https://github.com/tianma-if/edgeever/issues),方便后续用户检索和复用解决方案。
+- 贡献代码前请阅读[贡献代码须知](CONTRIBUTING.zh-CN.md)。如果您的 Fork 同时用于部署 EdgeEver,请将 `main` 分支仅用于部署;从官方 `upstream/main` 新建独立分支,在该分支中同步上游、开发并提交 Pull Request,不要在部署用的 `main` 上开发或执行 Sync fork。
-Docker 与 Cloudflare 共用同一套前端、API 路由、业务服务、鉴权、MCP 实现和 migration。容器使用 SQLite,并支持本地文件或 S3 兼容附件存储,提供 `amd64` 与 `arm64` 镜像。详见[使用 Docker 部署 EdgeEver](docs/deploy-docker.zh-CN.md)和[自托管与 Docker 架构](docs/self-hosting-architecture.zh-CN.md)。
+<hr>
-## 同步时序
+<h3 id="wechat-group">微信交流群</h3>
-Web、PWA 与桌面端会在停止编辑 30 秒后上传笔记,并在页面可见时每 5 分钟检查云端变更;窗口聚焦与手动刷新仍会立即拉取。可在 [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) 中调整 `DEFERRED_MEMO_SYNC_DELAY_MS` 和 `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS`。
+欢迎加入 EdgeEver AI 交流群,这里聚集了大量 Vibe Coding 与 AI 玩家。一起交流前沿 AI 生产力与个人知识库的最佳实践。
+
+> 扫描下方二维码或添加微信 `m1245207870`(备注“EdgeEver 进群”),群主将手动邀请入群。
+
+<p align="center">
+ <img src="assets/wechat-group-qr.jpg" alt="微信联系人二维码" width="260" />
+</p>
## 赞助与支持
diff --git a/README.zh-TW.md b/README.zh-TW.md
index d6fbc79a..46dddd4d 100644
--- a/README.zh-TW.md
+++ b/README.zh-TW.md
@@ -19,13 +19,14 @@
<p>
<a href="#wechat-group"><img src="assets/readme/community/wechat.svg" alt="WeChat" width="16" height="16" align="absmiddle" /> 微信交流群</a> &nbsp;|&nbsp;
<a href="https://demo.edgeever.org">🌐 線上展示</a> &nbsp;|&nbsp;
- <a href="#用戶端下載">📱 用戶端下載</a> &nbsp;|&nbsp;
+ <a href="#全平台用戶端與瀏覽器外掛">📱 用戶端與外掛下載</a> &nbsp;|&nbsp;
<a href="#features">核心特性與場景</a>
</p>
+ <p>
+ <img src="assets/readme/hero.png" alt="EdgeEver 三欄工作台與 AI 伴侶介面" width="880" />
+ </p>
</div>
-
-
EdgeEver 是一款現代化的開源筆記與個人知識庫工作區。它延續經典高效的三欄工作區體驗(目錄樹 · 筆記列表 · 編輯寫作),同時具備完全開放的資料架構與原生 AI Agent 聯動能力,讓個人知識沉澱更輕量、更自由。
> 💡 **終身免伺服器,100% 免費**
@@ -35,14 +36,16 @@ EdgeEver 是一款現代化的開源筆記與個人知識庫工作區。它延
## 為什麼做 EdgeEver
-很多**筆記與個人知識庫**的使用者,核心需求只是一個**可靠、開放、回應迅速**的個人知識庫。然而,當下的主流方案都各有痛點:
+很多**筆記與個人知識庫**的使用者,核心需求只是一個**可靠、開放、回應迅速**的個人知識庫。主流方案各有側重與取捨:
-* **印象筆記 / Evernote**:曾擁有最無感、最絲滑的多端雲端同步體驗。然而隨著它演進為全功能商業套件,廣告與附加功能漸多,系統開銷也隨之走高;加之免費版配額收緊、高級 AI 訂閱昂貴,且難以靈活接入現代自託管與私有 AI 工作流。
-* **Obsidian**:Markdown 開放,核心閉源;官方同步收費,第三方同步繁瑣;純本地檔案依賴遍歷掃描,當筆記累積到數千上萬條或載入複雜外掛後,冷啟動與全庫檢索明顯卡頓遲緩;圖片與附件與文字混存,儲存庫體積極易膨脹導致行動端同步緩慢,且刪除筆記後殘留附件難清理;對於「隨時隨地隨手記」的輕量場景來說偏重。
-* **Memos / Flomo 等輕量筆記**:雖然簡單好用,但時間軸卡片版面與習慣了經典「三欄工作流程」的使用者有著天然的互動習慣差異。
-* **思源筆記等區塊級知識庫**:功能深厚且支援開源自託管,但全盤的「區塊級(Block)」架構使得日常隨手記錄與連續排版書寫的心智負擔偏重;且缺少零伺服器成本的 Serverless 部署型態,多端同步主要依賴官方付費訂閱,或需額外付費解鎖 S3/WebDAV 同步特性並自備儲存。
+| 方案類型 | 代表產品 | 版面與互動體驗 | 同步機制與自託管成本 | AI 與 Agent 擴充生態 |
+| :--- | :--- | :--- | :--- | :--- |
+| **傳統商業雲筆記** | 印象筆記 / Evernote | 經典三欄版面,功能逐漸膨脹重型化 | 免費額度收緊,高級商業訂閱昂貴 | 商業封閉生態,難以接入私有 AI 工作流 |
+| **本地檔案雙鏈庫** | Obsidian | 本地資料夾與標籤頁,大量筆記檢索易卡頓 | 核心程式碼閉源,官方同步收費,附件混存易膨脹 | 依賴社群外掛,缺乏原生雲端與 Agent 協定 |
+| **輕量卡片 / 區塊級知識庫** | Memos / 思源筆記 | 串流卡片或全面區塊級架構,書寫心智負擔偏重 | 需自備伺服器,或依賴官方訂閱與付費解鎖同步 | 側重單點記錄,難以兼顧長文與原生 Agent 協同 |
+| **Serverless 全端開源知識庫** | **EdgeEver** | **經典三欄工作區 + 富文字與 Markdown 雙視圖** | **Cloudflare 零成本免維代管 / Docker 本地自建** | **原生內建 Remote MCP & 桌面端 ACP 深度互聯** |
-**EdgeEver 恰好填補了這一空白**:全端開源,提供真正**零感知、低延遲的多端瞬時雲端同步**,且全部服務均可免費自行託管;同時保留經典三欄版面與流暢排版,萬條筆記常駐依然輕盈絲滑,原生支援接入 AI Agent,部署維護零門檻、零費用。
+**EdgeEver 恰好填補了这一空白**:全端開源,提供真正**零感知、低延遲的多端瞬時雲端同步**,且全部服務均可免費自行託管;同時保留經典三欄版面與流暢排版,萬條筆記常駐依然輕盈絲滑,原生支援接入 AI Agent,部署維護零門檻、零費用。
## 線上展示
@@ -50,7 +53,9 @@ EdgeEver 是一款現代化的開源筆記與個人知識庫工作區。它延
公開展示環境會在每天凌晨 3:00(北京時間)自動重設並還原範例筆記,請不要儲存私密內容。
-## 用戶端下載
+## 全平台用戶端與瀏覽器外掛
+
+### 用戶端下載
<p>
<a href="https://github.com/tianma-if/edgeever/releases/latest"><img src="assets/readme/platforms/macos.svg" alt="下載 macOS 用戶端" width="40" height="40" /></a>&nbsp;&nbsp;
@@ -62,34 +67,55 @@ EdgeEver 是一款現代化的開源筆記與個人知識庫工作區。它延
> iOS 用戶端需要使用非中國大陸區 Apple ID 下載。
+### 瀏覽器網頁擷取外掛
+
+<p>
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="為 Google Chrome 安裝 EdgeEver 網頁擷取外掛" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="為 Microsoft Edge 安裝 EdgeEver 網頁擷取外掛" width="36" height="36" /></a>&nbsp;&nbsp;
+ <a href="https://addons.mozilla.org/zh-TW/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="為 Firefox 安裝 EdgeEver 網頁擷取外掛" width="36" height="36" /></a>
+</p>
+
+- **智慧正文擷取**:自動提取網頁文章正文並轉為純淨 Markdown,自動保留來源網址與擷取時間。
+- **選取範圍與按右鍵擷取**:選取局部文字或按右鍵任意圖片直接儲存為獨立筆記,無需抓取整頁冗餘內容。
+- **社群媒體與技術社群深度擷取**:深度適配 X (Twitter)、小紅書、知乎、Reddit、GitHub、Bilibili、YouTube 等十餘個主流平台,一鍵結構化入庫。
+- **自託管隱私直連**:擷取內容直傳個人自託管實例,不經過任何第三方伺服器轉發。
+
<a id="features"></a>
## 核心特性與場景
從跨渠道內容捕獲到深度知識表達與業務協同,EdgeEver 為個人與團隊提供了高效流暢的端到端工作流:
-### 全渠道剪藏與多媒體沉澱
-- **跨平台一鍵剪藏**:瀏覽器外掛深度適配 [小紅書畫廊](docs/best-practices.zh-CN.md#2-小红书图文笔记一键剪藏)、[X (Twitter) 推文與引用](docs/best-practices.zh-CN.md#3-x-twitter-推文与引用一键剪藏)、[知乎問答](docs/best-practices.zh-CN.md#4-知乎回答与文章一键精准剪藏)、[Reddit](docs/best-practices.zh-CN.md#5-reddit-讨论帖一键剪藏)、[GitHub](docs/best-practices.zh-CN.md#8-github-开源仓库信息一键剪藏) 以及 Bilibili、YouTube、小宇宙等十餘個主流社群與影音平台;手機端透過系統分享一鍵轉存[全網圖片](docs/best-practices.zh-CN.md#9-移动端社媒图片一键转存笔记)與[微信公眾號文章](docs/best-practices.zh-CN.md#10-手机端一键剪藏微信公众号文章)。
-- **微信聊天記錄完整歸檔**:macOS 端支援在微信中將聊天記錄「轉發到其他應用 → EdgeEver」,一鍵整段匯入為結構化筆記,完整保留發言人、時間軸、引用回覆及微信表情,圖片自動內嵌,影片與檔案自動轉為筆記附件。詳見[微信聊天記錄一鍵歸檔與整理](docs/best-practices.zh-CN.md#1-微信聊天记录一键归档与整理)。
-- **通用檔案附件與端側圖片壓縮**:支援輕鬆上傳並插入 PDF、Office 文件、壓縮檔及影音等各種附件,分塊上傳與串流處理安全支援最大 1 GiB 附件;圖片上傳前在瀏覽器端靜默完成壓縮,常見截圖與大圖精簡 50%-90% 體積,載入更迅速、儲存更省心。
+### 精選核心場景實機預覽
-### 智慧視覺化與多維資料協作
-- **全類型視覺化圖表與專業資訊圖**:告別外部繪圖軟體,借助伴隨式 AI 助手自然語言一句話產生可互動編輯的[心智圖、流程圖與架構圖](docs/best-practices.zh-CN.md#11-ai-对话一键生成思维导图流程图与架构图)(詳見[視覺化圖表筆記設計說明](docs/visual-diagram-notes.zh-CN.md),原生支援 Mermaid 程式碼區塊繪製);內建豐富模板庫,一鍵產生精美專業的[全類型視覺化資訊圖(時間線、對比圖、象限矩陣等)](docs/best-practices.zh-CN.md#12-ai-智能生成专业信息图时间线对比图架构图等)。
-- **AI 多維表格與線上收集表單**:自然語言一句話按需建構[任意業務場景多維表格](docs/best-practices.zh-CN.md#13-借助右侧-ai-助手一句话生成多维表格)(如專案管理、選題庫、人事資產等),自動推斷單選標籤、日期等欄位類型並預置真實範例資料;支援一鍵開啟無需登入的[對外公開線上收集表單](docs/best-practices.zh-CN.md#14-多维表格一键生成在线公开收集表单),使用者填報資料即時沉澱入庫。
-- **原生海報筆記與 AI 視覺排版**:原生支援基於畫布的結構化海報筆記,內建豐富的圖文卡片模板與版式佈局;支援按兩下編輯文案、替換圖片與預留位置,支援一鍵自適應縮放;伴隨式 AI 助手與 ACP / MCP 協定可直接理解、產生並協同精修海報內容。
-- **雙視圖編輯、空間組織與知識庫公開發布**:桌面端支援在富文字與 Markdown 原始碼檢視之間自由切換;經典三欄版面與可調節面板寬度、一鍵專注模式與無限層級筆記本,支援筆記批次合併/移動與拖放排序;提供自動版本回溯;除單篇筆記加密分享外,更支援**將整個筆記本一鍵公開發布為帶目錄樹導覽的獨立知識庫網站**,並提供存取密碼保護。
+| 💡 AI 一鍵產生心智圖與架構圖 | 📊 AI 業務多維表格與線上收集表單 |
+| :---: | :---: |
+| <img src="docs/assets/best-practices/ai-diagram-mindmap.png" alt="AI 一鍵產生心智圖" width="420" /> | <img src="docs/assets/best-practices/ai-database-employee-roster.png" alt="AI 一鍵建構多維表格" width="420" /> |
+| **💬 微信聊天記錄一鍵整段結構化歸檔** | **🎨 微信公眾號一鍵排版與內聯格式複製** |
+| <img src="docs/assets/best-practices/wechat-chat-imported-note.png" alt="微信聊天記錄歸檔" width="420" /> | <img src="docs/assets/best-practices/copy-to-wechat-mp-menu.png" alt="微信公眾號排版複製" width="420" /> |
-### 創作者排版與一鍵發布
-- **微信公眾號一鍵排版與複製**:專為中文創作者設計,支援將筆記一鍵轉換為帶行內樣式的公眾號美化格式,[一鍵複製內聯富文本到微信公眾號](docs/best-practices.zh-CN.md#6-一键复制笔记到微信公众号排版)後台直接貼上發布,告別複雜的第三方排版工具。
-- **高質感長圖分享與多格式匯出**:任意筆記均可一鍵[分享為高質感長圖海報](docs/best-practices.zh-CN.md#7-ai-rss-智能订阅日报与精美长图分享),內建多款質感主題、Monogram 字母頭像、自適應版式、自訂字型與卡片版式,優雅分發至社群平台;支援單篇筆記獨立便捷匯出為 Markdown、HTML 或 PDF。
-- **AI RSS 智慧訂閱日報**:內建官方 AI RSS 訂閱外掛,自動定時聚合產業資訊與部落格源,AI 過濾雜訊並產生結構嚴謹、重點清晰的精煉日報筆記。
+### 1. 全渠道剪藏與多媒體沉澱
+- **跨平台一鍵剪藏**:外掛深度適配 [小紅書](docs/best-practices.zh-CN.md#2-小红书图文笔记一键剪藏)、[X (Twitter)](docs/best-practices.zh-CN.md#3-x-twitter-推文与引用一键剪藏)、[知乎](docs/best-practices.zh-CN.md#4-知乎回答与文章一键精准剪藏)、[Reddit](docs/best-practices.zh-CN.md#5-reddit-讨论帖一键剪藏)、[GitHub](docs/best-practices.zh-CN.md#8-github-开源仓库信息一键剪藏)、B站及 YouTube;手機端支援[全網圖片](docs/best-practices.zh-CN.md#9-移动端社媒图片一键转存笔记)與[公眾號文章一鍵剪藏](docs/best-practices.zh-CN.md#10-手机端一键剪藏微信公众号文章)。
+- **微信聊天記錄完整歸檔**:macOS 端支援微信一鍵轉發整段對話匯入筆記,完整保留時間軸、頭像、表情、附件與圖片,詳見[微信歸檔說明](docs/best-practices.zh-CN.md#1-微信聊天记录一键归档与整理)。
+- **通用檔案附件與端側圖片壓縮**:支援各類影音與辦公檔案(串流分塊最高 1 GiB);瀏覽器端靜默智慧壓縮圖片,節省 50%-90% 儲存空間。
-### 原生 AI Agent 與開放生態
-- **原生 Agent 協定深度互聯(MCP & ACP)**:內建 MCP(Model Context Protocol)協定,支援外部 AI Agent 直接讀取與整理筆記;桌面端支援透過 ACP(Agent Client Protocol)協定直接調用本機執行的 AI Agent(如 Codex、Antigravity、Claude Code、WorkBuddy 等)協同創作。
-- **接入自有模型與開放外掛 API**:支援新增多個 OpenAI、Anthropic、Gemini 相容服務與第三方中轉平台,在伴侶側邊欄與編輯器中隨時對全文或選取範圍進行智慧摘要、重點擷取、文法校對、翻譯與續寫潤飾;提供豐富的[外掛開發文件](docs/plugin-development.zh-CN.md)自由擴充功能。
+### 2. 智慧視覺化與多維資料協作
+- **全類型視覺化圖表與專業資訊圖**:AI 一句話直接產生可編輯的[心智圖、流程圖與架構圖](docs/best-practices.zh-CN.md#11-ai-对话一键生成思维导图流程图与架构图)(詳見[圖表筆記設計](docs/visual-diagram-notes.zh-CN.md));內建模板一鍵產生[時間線、對比圖等資訊圖](docs/best-practices.zh-CN.md#12-ai-智能生成专业信息图时间线对比图架构图等)。
+- **AI 多維表格與線上收集表單**:自然語言一鍵建構[任意業務場景多維表格](docs/best-practices.zh-CN.md#13-借助右侧-ai-助手一句话生成多维表格),自動推斷欄位與範例資料;支援一鍵產生免登入[對外線上收集表單](docs/best-practices.zh-CN.md#14-多维表格一键生成在线公开收集表单)。
+- **原生海報筆記與 AI 視覺排版**:內建結構化圖文卡片模板與排版畫布,支援按兩下編輯、替換素材與一鍵自適應縮放,AI 助手可直接協同產生。
+- **雙視圖編輯與知識庫公開發布**:支援富文字與 Markdown 原始碼自由切換;提供經典三欄無限層級樹、版本回溯,以及**整本筆記本一鍵公開發布為帶目錄樹的獨立網站**。
-### 開放架構、全端體驗與安全基座
-- **自由部署與資料無圍牆**:既可免費執行於 Cloudflare Serverless(個人免費額度約容納 15 萬條短筆記與 5 萬張圖片),也可透過 Docker 部署到 VPS、NAS 或家用伺服器(輕鬆承載百萬級筆記與海量圖片);基於標準 SQLite 儲存,提供 REST API、CLI 介面與無損 ZIP 完整檔案匯出匯入,資料完全自主不設圍牆。
-- **全平台涵蓋與穩定安全**:官方涵蓋 Web、[Android](https://play.google.com/store/apps/details?id=org.edgeever.mobile&hl=zh-TW)、[macOS](https://github.com/tianma-if/edgeever/releases)、[Windows](https://github.com/tianma-if/edgeever/releases/latest)、[Linux](https://github.com/tianma-if/edgeever/releases/latest) 及 [iOS](https://apps.apple.com/tw/app/edgeever/id6792625631)(網頁擷取擴充功能支援 [Chrome](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo)、[Edge](https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo) 和 [Firefox](https://addons.mozilla.org/zh-TW/firefox/addon/edgeever-web-clipper/)),自託管多端同步無裝置數量限制;桌面端輕快省記憶體,支援離線草稿與同步佇列、伺服端防暴力破解限流保護,以及多帳號空間資料隔離。
+### 3. 創作者排版與一鍵發布
+- **微信公眾號一鍵排版與複製**:專為創作者打造,筆記一鍵轉換為帶行內樣式的公眾號格式,[一鍵複製內聯富文本](docs/best-practices.zh-CN.md#6-一键复制笔记到微信公众号排版)到後台直接發布。
+- **高質感長圖分享與多格式匯出**:任意筆記一鍵[產生精美長圖海報](docs/best-practices.zh-CN.md#7-ai-rss-智能订阅日报与精美长图分享),內建多套質感版式;支援匯出 Markdown、HTML 與 PDF。
+- **AI RSS 智慧訂閱日報**:內建 AI RSS 外掛,自動定時抓取資訊與部落格,AI 過濾雜訊並產生精煉日報。
+
+### 4. 原生 AI Agent 與開放生態
+- **原生 Agent 協定互聯(MCP & ACP)**:內建 MCP 協定供外部 AI Agent 安全讀寫管理知識庫;桌面端透過 ACP 協定直接調動本機 Agent(Codex、Claude Code、Antigravity 等)協同創作。
+- **接入自有模型與開放外掛 API**:支援接入 OpenAI、Anthropic、Gemini 相容服務,在側邊欄隨時進行摘要與翻譯;提供豐富的[外掛開發文件](docs/plugin-development.zh-CN.md)。
+
+### 5. 開放架構、全端體驗與安全基座
+- **自由部署與資料無圍牆**:支援 Cloudflare Serverless 零成本代管(免費額度約容納 15 萬條筆記)或 Docker 本地部署(承載百萬級筆記與海量圖片);標準 SQLite 儲存,支援無損 ZIP 匯入匯出。
+- **全平台涵蓋與穩定安全**:官方涵蓋 Web、Android、iOS、macOS、Windows、Linux 與主流瀏覽器外掛,多端同步無裝置數量限制;支援離線草稿、同步佇列與防暴力破解限流。
👉 查看全部 14 個實機展示與操作效果:**[完整場景與最佳實踐指南](docs/best-practices.zh-CN.md)**
@@ -123,13 +149,16 @@ Cloudflare 線上部署可以選擇以下兩種方式之一:
### 方案二:手動線上部署
+<details>
+<summary>📖 展開查看:網頁端 6 步手動部署流程</summary>
+
只需在網頁端完成 6 步設定:
1. **Fork 儲存庫**:在 GitHub 點選右上角 **Fork**,將專案 Fork 到您的個人帳戶下。
2. **建立 Cloudflare 資源**:建立 D1 `edgeever` 與 R2 `edgeever-resources`。
3. **匯入並設定專案**:在 Cloudflare **Workers & Pages** 中從 Fork 的 `main` 分支建立名為 `edgeever` 的 Worker。使用儲存庫根目錄,保留由 Cloudflare 線上執行的 Workers Builds 預設部署指令,並確認其 API Token 具備 D1 讀取及編輯權限。binding 由部署指令產生,不要修改 Fork 中的檔案。
4. **準備管理員密碼**:準備管理員登入密碼,建議至少 32 個字元。Worker 建立後,將它儲存為執行時 Secret `EDGE_EVER_AUTH_PASSWORD`。
-5. **首次建置與驗證**:儲存並部署會建立 Worker 並啟動建置。如因缺少管理員 Secret 而失敗,新增步驟 4 的執行時 Secret 後重試。管理員使用者名稱預設為 `admin`;如需使用其他名稱,請在重試建置前設定 Workers Builds 建置變數 `EDGE_EVER_AUTH_USERNAME`。部署完成後造訪 `/api/health`,確認回傳 `200`,再用設定的管理員使用者名稱和密碼登入。
+5. **首次建置與驗證**:儲存並部署會建立 Worker 並啟動建置。首次建置主要用於初始化實例,若因尚未配置管理員 Secret 而報錯屬於預期行為,只需在第 4 步新增執行時 Secret `EDGE_EVER_AUTH_PASSWORD` 後點擊重試建置即可通過。管理員使用者名稱預設為 `admin`;如需使用其他名稱,請在重試建置前設定 Workers Builds 建置變數 `EDGE_EVER_AUTH_USERNAME`。部署完成後造訪 `/api/health`,確認回傳 `200`,再用設定的管理員使用者名稱和密碼登入。
6. **啟用自動更新**:進入 Fork 的 **Actions** 分頁,點選 **I understand my workflows, go ahead and enable them**,然後手動執行一次 **Update deployed EdgeEver**,確保後續能夠自動獲得正式版本的功能更新與修復。
> 📖 包含具體參數與建置指令的詳細步驟,請查看 [線上部署完整文件](docs/deploy-cloudflare-button.zh-CN.md)。
@@ -138,105 +167,107 @@ Cloudflare 線上部署可以選擇以下兩種方式之一:
> 💡 **Cloudflare R2 開通**:雖然 Cloudflare R2 儲存提供了足夠寬裕、在筆記場景中完全不會超量的[免費儲存額度](https://developers.cloudflare.com/r2/pricing/#free-tier),但需先開通 R2 subscription 並綁定付款方式。Cloudflare [官方支援](https://developers.cloudflare.com/billing/get-started/update-billing-info/#supported-payment-methods) 銀聯(UnionPay)、Visa、Mastercard 等金融卡與信用卡,以及 PayPal、Apple Pay、Google Pay 等付款方式。
+</details>
+
### 方案三:在 VPS 或 NAS 上使用 Docker
-使用 GitHub 託管的安裝指令碼和官方 GHCR 映像:
+Docker 與 Cloudflare 共用同一套前端、API 路由、業務服務、鑑權、MCP 實現和 migration。容器使用 SQLite,並支援本地檔案或 S3 相容附件儲存,提供 `amd64` 與 `arm64` 映像檔。詳見[使用 Docker 部署 EdgeEver](docs/deploy-docker.zh-CN.md)和[自託管與 Docker 架構](docs/self-hosting-architecture.zh-CN.md)。
+
+使用 GitHub 託管的安裝指令碼和官方 GHCR 映像檔:
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
-此指令會自動拉取最新映像、產生管理員密碼,並使用 Docker Compose 啟動 EdgeEver。手動部署與設定說明見 [Docker 部署文件](docs/deploy-docker.zh-CN.md)。
+該指令會自動拉取最新映像檔、產生管理員密碼,並使用 Docker Compose 啟動 EdgeEver。安裝後預設每日自動更新;如需手動更新,請在部署伺服器上執行 `~/edgeever/update.sh`。
-安裝後預設每日自動更新。如需手動更新,請在部署伺服器上執行 `~/edgeever/update.sh`。
+> 💡 **網路提示**:官方映像檔託管於 GitHub(GHCR)。若在部分網路環境下遇到拉取緩慢或逾時,請在部署前自行設定可用的網路代理或可信的映像檔加速服務。
---
-## 多帳號登入與儲存用量
+## 資料遷移與進階使用
-部署完成後,單一實例支援多帳號登入。
+### 匯入與遷移 (Migration)
-實例管理員可以在 **個人中心** -> **帳號管理** 中建立、停用成員帳號或重設密碼。每個成員擁有完全隔離的個人空間,包括筆記本、筆記、附件、回收筒、匯入匯出和 MCP Token 等。系統同時提供直觀的儲存用量面板,可即時掌握實例整體與各帳號的附件儲存占用明細。
+如果你想從其他筆記軟體遷移到 EdgeEver,請參考以下極簡遷移指引:
-## 瀏覽器網頁擷取擴充功能
+- **印象筆記(Evernote)的遷入**:請參考 [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
+- **flomo 筆記的遷入**:請參考 [docs/flomo-migration-guide.md](docs/flomo-migration-guide.md)
+- **Memos 筆記的遷入**:請參考 [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
+- **Notion 筆記的遷入**:請參考 [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
-<p>
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/chrome/chrome.svg" alt="為 Google Chrome 安裝 EdgeEver 網頁擷取擴充功能" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://chromewebstore.google.com/detail/edgeever-web-clipper/gjadpfmanienmlofajibkfkkpfdkclgo"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/edge/edge.svg" alt="為 Microsoft Edge 安裝 EdgeEver 網頁擷取擴充功能" width="36" height="36" /></a>&nbsp;&nbsp;
- <a href="https://addons.mozilla.org/zh-TW/firefox/addon/edgeever-web-clipper/"><img src="https://raw.githubusercontent.com/alrra/browser-logos/58881b84c4d73adc03c06fa2c275a7abee02d935/src/firefox/firefox.svg" alt="為 Firefox 安裝 EdgeEver 網頁擷取擴充功能" width="36" height="36" /></a>
-</p>
+### MCP 原生整合
-- **智慧內文擷取**:自動擷取網頁文章正文並轉為純淨 Markdown,完整保留來源網址與擷取時間。
-- **選取與右鍵擷取**:反白選取文字或右鍵任意圖片直接儲存為獨立筆記,無需抓取整頁多餘內容。
-- **社群與社群深度擷取**:深度適配 X (Twitter)、小紅書、知乎、Reddit、GitHub、Bilibili、YouTube 等十餘個主流社群、技術社群與影音平台,一鍵結構化入庫。
-- **自託管隱私直連**:擷取內容直傳個人自託管執行個體,不經過任何第三方伺服器轉發。
+在 **個人中心** -> **API / MCP** 中建立 API Token 並一鍵複製 Remote MCP 設定,即可讓 Claude Code、Cursor、Antigravity、OpenClaw 等 AI Agent 在帳號授權範圍內安全管理你的知識庫。系統支援文字筆記、圖表筆記(心智圖、流程圖與架構圖)、多維表格筆記與原生海報筆記的完整增刪改查,Agent 還可管理筆記本目錄、標籤、附件、歷史版本、筆記模板與 AI 指令。
-## 社群與回饋
+> 💡 **場景啟發:**
+> 讓 AI 真正成為你的知識管家與創作外腦——不僅能將方案秒級產生為可互動的心智圖、流程圖、架構圖與多維表格,還能為 AI Agent 提供私有知識上下文。依托 EdgeEver 強大的富文字編輯與精美排版能力,AI 協同沉澱的不再是冰冷文字,而是結構工整、排版優雅、隨時可一鍵分發的高品質知識資產。
-- Bug、功能建議和部署問題請優先提交 [GitHub Issues](https://github.com/tianma-if/edgeever/issues),方便後續使用者檢索和重用解決方案。
-- 貢獻程式碼前請閱讀[貢獻程式碼須知](CONTRIBUTING.zh-CN.md)。如果您的 Fork 同時用於部署 EdgeEver,請將 `main` 分支僅用於部署;從官方 `upstream/main` 新建獨立分支,在該分支中同步上游、開發並提交 Pull Request,不要在部署用的 `main` 上開發或執行 Sync fork。
+### 多帳號登入與儲存用量
-<hr>
+部署完成後,單個實例支援多帳號登入。實例管理員可以在 **個人中心** -> **帳號管理** 中建立、停用成員帳號或重設密碼。每個成員擁有完全隔離的個人空間,包括筆記本、筆記、附件、資源回收筒、匯入匯出和 MCP Token 等。系統同時提供直觀的儲存用量面板,可即時掌握實例整體與各帳號的附件儲存占用明細。
-<h3 id="wechat-group">微信交流群</h3>
+### 高級物件儲存與第三方圖床
-歡迎加入 EdgeEver AI 交流群,這裡聚集了大量 Vibe Coding 與 AI 玩家。一起交流前沿 AI 生產力與個人知識庫的最佳實踐。
+- **OSS 物件儲存**:實例 Owner 可在**設定 → 進階設定 → OSS 物件儲存**中設定相容 S3 API 的物件儲存。切換儲存不會遷移或影響已有附件。
+- **桌面端 PicGo 圖床**:桌面端支援可選接入本機 PicGo 用戶端服務,在筆記中插入圖片時可直接上傳至 GitHub、SM.MS、又拍雲、七牛雲或自建圖床,進一步減少自託管實例的儲存開銷與流量占用。
-> 掃描下方 QR Code 或加入微信 `m1245207870`(備註「EdgeEver 進群」),群主將手動邀請入群。
+### 外掛與主題
-<p align="center">
- <img src="assets/wechat-group-qr.jpg" alt="微信聯絡人 QR Code" width="260" />
-</p>
+Web 與桌面端支援功能外掛與個性化主題,可從官方市場、GitHub 或 Manifest 位址一鍵安裝,並隨工作區跨端同步。開發者可使用 `@edgeever/plugin-api` 擴充能力,詳見[外掛開發文件](docs/plugin-development.zh-CN.md)與[官方外掛市場上架政策](docs/plugin-marketplace-policy.zh-CN.md)。
-## 外掛與主題
+---
-Web 與桌面版支援功能外掛與個人化主題,可從官方市集、GitHub 或 Manifest 網址一鍵安裝,並隨工作區跨端同步。開發者可使用 `@edgeever/plugin-api` 擴充功能,詳情參閱[外掛開發文件](docs/plugin-development.zh-CN.md)與[官方外掛市集上架政策](docs/plugin-marketplace-policy.zh-CN.md)。
+## 開發者指南與架構
-## 技術棧
+### 技術棧
-- Bun workspace monorepo,包含 Web、API、官網與共享型別套件。
+- Bun workspace monorepo,包含 Web、API、官網與共享型別包。
- 前端:Vite、React、React Router、TanStack Query,UI 基於 Tailwind CSS、shadcn/ui、Radix UI。
- 編輯器:TipTap / ProseMirror,支援 Markdown;PWA 使用 vite-plugin-pwa、Workbox、Dexie。
-- Android App:`apps/mobile` 中的 Expo + React Native,採用 SQLite 本機儲存與增量同步。
-- iOS App:`apps/ios` 中的原生 SwiftUI(iOS 17+),內建 TipTap EditorBundle、GRDB 本機鏡像/outbox,介面與 Android 殼層對齊。
-- 原生桌面版:Electron + Rust sidecar,兼顧跨平台一致體驗與高效能本機資料服務;基於 SQLite 支援離線編輯、連網後增量同步與本機備份。
+- Android App:`apps/mobile` 中的 Expo + React Native,採用 SQLite 本地儲存與增量同步。
+- iOS App:`apps/ios` 中的原生 SwiftUI(iOS 17+),內建 TipTap EditorBundle、GRDB 本地鏡像/outbox,介面與 Android 殼層對齊。
+- 原生桌面端:Electron + Rust sidecar,兼顧跨平台一致體驗與高效能本地資料服務;基於 SQLite 支援離線編輯、連網後增量同步與本地備份。
- 網頁擷取:Manifest V3、Mozilla Readability、Turndown,支援 Chrome、Microsoft Edge 與 Firefox。
-- 後端:一套基於 Hono/Zod 的業務應用,提供 REST API 與 Remote MCP;Cloudflare 使用 Workers/D1/R2,Docker 使用 Bun/SQLite/本機檔案或 S3。
-- 官網:Astro 靜態網站,位於 `apps/site`,可獨立建置並部署到 Cloudflare Pages。
+- 後端:一套基於 Hono/Zod 的業務應用,提供 REST API 與 Remote MCP;Cloudflare 使用 Workers/D1/R2,Docker 使用 Bun/SQLite/本地檔案或 S3。
+- 官網:Astro 靜態站點,位於 `apps/site`,可獨立建置並部署到 Cloudflare Pages。
-## 快速開始
+### 快速開始
```sh
bun install
bun run dev
```
-本機開發預設自動登入,首次帳號為 `owner` / `edgeever-local-dev`;測試登入頁可主動登出。
+本地開發預設自動登入,首次帳號為 `owner` / `edgeever-local-dev`;測試登入頁可主動登出。
-## 目錄結構
+### 目錄結構
```text
apps/web Vite + React 前端、PWA、離線草稿與同步佇列
-apps/extension Chrome/Edge/Firefox Manifest V3 網頁擷取擴充功能
+apps/extension Chrome/Edge/Firefox Manifest V3 網頁擷取外掛
apps/api Cloudflare Worker + Hono API、MCP endpoint
apps/mobile Expo + React Native Android App
apps/ios 原生 SwiftUI iOS App(TipTap EditorBundle、GRDB)
-apps/desktop Electron 桌面版殼層、preload bridge 與原生打包設定
+apps/desktop Electron 桌面端殼層、preload bridge 與原生打包設定
apps/site Astro 官方網站,可獨立部署
packages/client Web 與行動端共享的 API Client
packages/shared 共享型別、Zod schema、TipTap / Markdown 內容轉換
crates/desktop-sidecar
- Rust sidecar,負責本機 SQLite、離線資料、備份與資源服務
-scripts Wrangler 封裝、密碼雜湊、CLI、MCP stdio bridge、Evernote ENEX 匯入
+ Rust sidecar,負責本地 SQLite、離线資料、備份與資源服務
+scripts Wrangler 封裝、密碼 hash、CLI、MCP stdio bridge、Evernote ENEX 匯入
migrations D1/SQLite 共用、只增不改的資料庫 migration
docs 架構、遷移與部署文件
-.github/workflows Web、行動端、iOS、桌面版打包、部署與 Release 的 CI
+.github/workflows Web、行動端、iOS、桌面端打包、部署與 Release 的 CI
wrangler.toml Cloudflare Workers、Assets、D1、R2 設定
```
-## 內容格式
+<details>
+<summary>⚙️ 架構設計與同步實現細節(點擊展開)</summary>
+
+#### 內容格式
-EdgeEver 同時保存三種內容形態:
+EdgeEver 同時儲存三種內容型態:
```text
content_json TipTap/ProseMirror 文件,編輯器權威格式
@@ -244,41 +275,38 @@ content_markdown API、Agent、匯入匯出使用
content_text 搜尋、摘要和索引使用
```
-請開啟 **我的** -> **匯入與匯出**,匯出或匯入 EdgeEver ZIP。壓縮檔中的 `notes/` 目錄可直接作為 Markdown 閱讀和遷移,結構化資料則用於在 EdgeEver 實例之間完整還原;匯入時目標實例中的無關資料會保留,相同 EdgeEver ID 的內容會被覆蓋。
-
-## MCP
+請打開 **我的** -> **匯入與匯出**,匯出或匯入 EdgeEver ZIP。壓縮包中的 `notes/` 目錄可直接作為 Markdown 閱讀和遷移,結構化資料則用於在 EdgeEver 實例之間完整還原;匯入時目標實例中的無關資料會保留,相同 EdgeEver ID 的內容會被覆寫。
-在 **個人中心** -> **API / MCP** 中建立 API Token 並一鍵複製 Remote MCP 設定,即可讓 Claude Code、Cursor、Antigravity、OpenClaw 等 AI Agent 在帳號授權範圍內安全管理你的知識庫。系統支援文字筆記、圖表筆記(心智圖、流程圖與架構圖)、多維表格筆記與原生海報筆記的完整增刪改查,Agent 還可管理筆記本目錄、標籤、附件、歷史版本、筆記範本與 AI 指令。
+#### 圖片壓縮規則
-> 💡 **情境啟發:**
-> 讓 AI 真正成為你的知識管家與創作外腦——不僅能將方案秒級產生為可互動的心智圖、流程圖、架構圖與多維表格,還能為 AI Agent 提供私有脈絡。憑藉 EdgeEver 強大的富文字編輯與精美排版能力,AI 協同沉澱的不再是冰冷文字,而是結構工整、排版優雅、隨時可一鍵分發的高品質知識資產。
+圖片壓縮僅在 Web 端上傳前執行,由設定頁的「壓縮筆記內圖片」開關控制。啟用後,瀏覽器會把 PNG、JPEG、WebP、AVIF 嘗試壓縮為 WebP,並將最長邊限制在 `2560px` 以內;如果壓縮結果不比原圖小,則保留原圖。
-## 圖片壓縮規則
+Cloudflare Worker 側執行圖片處理會消耗計算/圖片處理額度,因此 EdgeEver 將圖片壓縮放在 Web 用戶端完成;REST API 或 MCP 上傳入口會按用戶端提供的檔案內容直接入庫,不再由伺服端自動壓縮。
-圖片壓縮僅在 Web 端上傳前執行,由設定頁的「壓縮筆記內圖片」開關控制。啟用後,瀏覽器會把 PNG、JPEG、WebP、AVIF 嘗試壓縮為 WebP,並將最長邊限制在 `2560px` 以內;如果壓縮結果不比原圖小,則保留原圖。
+#### 同步時序
-Cloudflare Worker 側執行圖片處理會消耗運算/圖片處理額度,因此 EdgeEver 將圖片壓縮放在 Web 用戶端完成;REST API 或 MCP 上傳入口會依用戶端提供的檔案內容直接入庫,不再由伺服端自動壓縮。
+Web、PWA 與桌面端會在停止編輯 30 秒後上傳筆記,並在頁面可見時每 5 分鐘檢查雲端變更;視窗聚焦與手動重新整理仍會立即拉取。可在 [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) 中調整 `DEFERRED_MEMO_SYNC_DELAY_MS` 和 `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS`。
-## 進階物件儲存與第三方圖床
+</details>
-- **OSS 物件儲存**:實例 Owner 可在**設定 → 進階設定 → OSS 物件儲存**中設定相容 S3 API 的物件儲存。切換儲存不會遷移或影響既有附件。
-- **桌面端 PicGo 圖床**:桌面端支援可選接入本機 PicGo 用戶端服務,在筆記中插入圖片時可直接上傳至 GitHub、SM.MS、又拍雲、七牛雲或自建圖床,進一步減少自託管實例的儲存開銷與頻寬占用。
+---
-## 匯入與遷移 (Migration)
+## 社群與反饋
-若你想從其他筆記軟體遷移到 EdgeEver,請參考以下精簡遷移指引:
+- Bug、功能建議和部署問題請優先提交 [GitHub Issues](https://github.com/tianma-if/edgeever/issues),方便後續使用者檢索和複用解決方案。
+- 貢獻程式碼前請閱讀[貢獻程式碼須知](CONTRIBUTING.zh-CN.md)。如果您的 Fork 同時用於部署 EdgeEver,請將 `main` 分支僅用於部署;從官方 `upstream/main` 新建獨立分支,在該分支中同步上游、開發並提交 Pull Request,不要在部署用的 `main` 上開發或執行 Sync fork。
-- **Evernote(印象筆記)的遷入**:請參考 [docs/evernote-migration-guide.md](docs/evernote-migration-guide.md)
-- **Memos 筆記的遷入**:請參考 [docs/memos-migration-guide.md](docs/memos-migration-guide.md)
-- **Notion 筆記的遷入**:請參考 [docs/notion-migration-guide.md](docs/notion-migration-guide.md)
+<hr>
-## Docker 部署
+<h3 id="wechat-group">微信交流群</h3>
-Docker 與 Cloudflare 共用同一套前端、API 路由、業務服務、鑑權、MCP 實作和 migration。容器使用 SQLite,並支援本機檔案或 S3 相容附件儲存,提供 `amd64` 與 `arm64` 映像。詳見[使用 Docker 部署 EdgeEver](docs/deploy-docker.zh-CN.md)和[自行託管與 Docker 架構](docs/self-hosting-architecture.zh-CN.md)。
+歡迎加入 EdgeEver AI 交流群,這裡聚集了大量 Vibe Coding 與 AI 玩家。一起交流前沿 AI 生產力與個人知識庫的最佳實踐。
-## 同步時序
+> 掃描下方二維碼或新增微信 `m1245207870`(備註「EdgeEver 進群」),群主將手動邀請入群。
-Web、PWA 與桌面版會在停止編輯 30 秒後上傳筆記,並在頁面可見時每 5 分鐘檢查雲端變更;視窗聚焦與手動重新整理仍會立即拉取。可在 [`apps/web/src/lib/workspace-refresh.ts`](apps/web/src/lib/workspace-refresh.ts) 中調整 `DEFERRED_MEMO_SYNC_DELAY_MS` 和 `BACKGROUND_WORKSPACE_REFRESH_INTERVAL_MS`。
+<p align="center">
+ <img src="assets/wechat-group-qr.jpg" alt="微信聯絡人二維碼" width="260" />
+</p>
## 贊助與支持
@@ -289,17 +317,17 @@ EdgeEver 是免費開源專案。保持跨平台用戶端(macOS、Windows、Li
## 致謝
-- EdgeEver 的筆記產品設計也參考了 [Evernote(印象筆記)](https://evernote.com/)、[Notion](https://www.notion.com/) 等成熟筆記工具的公開產品體驗。相關功能由 EdgeEver 獨立設計與實作。
-- 心智圖與視覺化圖表筆記的產品設計參考了 [XMind](https://xmind.com/) 和 [ProcessOn](https://www.processon.com/) 等圖表工具的公開產品體驗。相關功能由 EdgeEver 獨立設計與實作。
-- EdgeEver 的海報設計工作台借鑑了向阳乔木(joeseesun)的 [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design),並基於其 MIT 開源授權改編了範本與字型排版引擎。
+- EdgeEver 的筆記產品設計也參考了 [Evernote(印象筆記)](https://evernote.com/)、[Notion](https://www.notion.com/) 等成熟筆記工具的公開產品體驗。相關功能由 EdgeEver 獨立設計與實現。
+- 心智圖與視覺化圖表筆記的產品設計參考了 [XMind](https://xmind.com/) 和 [ProcessOn](https://www.processon.com/) 等圖表工具的公開產品體驗。相關功能由 EdgeEver 獨立設計與實現。
+- EdgeEver 的海報設計工作台借鑑了向陽喬木(joeseesun)的 [Qiaomu Design](https://github.com/joeseesun/qiaomu-cover-design),並基於其 MIT 開源許可改編了模板與字型排版引擎。
- EdgeEver 圖片分享卡片的主題視覺與排版參考了 [流光卡片](https://fireflycard.shushiai.com/),感謝其設計帶來的啟發。
## 商標與品牌使用
-EdgeEver 名稱、Logo 及其他品牌識別用於識別官方專案。Fork 或修改版可以說明其「基於 EdgeEver」,但不得暗示官方身分或誤導使用者。開源授權不授予商標權利;其他使用須事先取得專案維護者的書面許可。
+EdgeEver 名稱、Logo 及其他品牌標識用於識別官方專案。Fork 或修改版可以說明其「基於 EdgeEver」,但不得暗示官方身分或誤導使用者。開源許可不授予商標權利;其他使用須事先取得專案維護者的書面許可。
## 免責聲明
EdgeEver 是一款完全獨立的開源筆記軟體,由個人和社群自主開發維護。本專案與 Evernote®(印象筆記)及其關聯公司不存在任何商業合作、授權、贊助或隸屬關係。
-EdgeEver 是自行託管軟體。除官方展示實例外,專案維護者不託管、控制或審核使用者內容。實例中儲存或展示的內容由使用者或實例營運者負責,不代表專案維護者的立場。
+EdgeEver 是自託管軟體。除官方展示實例外,專案維護者不託管、控制或審核使用者內容。實例中儲存或展示的內容由使用者或實例營運者負責,不代表專案維護者的立場。
diff --git a/assets/readme/hero.png b/assets/readme/hero.png
new file mode 100644
index 00000000..929b3e3b
Binary files /dev/null and b/assets/readme/hero.png differ