diff --git a/README.ja.md b/README.ja.md index 1b5eebc7..8ed1035e 100644 --- a/README.ja.md +++ b/README.ja.md @@ -90,7 +90,7 @@ EdgeEver は、オープンソースのノートと知識ベースの作業領 | **AI とエコシステム** | • サイドバーの伴走型 AI アシスタント（要約、校正、翻訳、推敲）
• BYOK（独自 API キー）：OpenAI、Anthropic、Gemini 互換プロトコル対応 | • **ネイティブ Agent プロトコル連携**：外部 Agent が読み書きできる MCP、ローカル Agent を直接呼び出す ACP を標準搭載
• **AI RSS 購読日報**：フィードを自動収集し、AI がノイズを排除して構造化日報を作成
• 自由な拡張を可能にするプラグイン開発 API | | **マルチ端末同期と基盤** | • PC・スマホ・タブレット間で低遅延・シームレスに同期、接続端末数無制限
• Web、macOS、Windows、Linux、iOS、Android の全プラットフォーム公式対応
• オフラインファーストと自動同期キュー：オフラインでも軽快に執筆、再接続時に自動増分同期
• 標準 SQLite、可逆 ZIP アーカイブ・Markdown の入出力に対応 | • **生涯サーバー代ゼロ**：Cloudflare の無料枠で 100% 稼働（短文約 15 万件＋画像約 5 万枚）
• **自由な Docker セルフホスト**：自宅サーバー・VPS・NAS にワンクリック配置、数百万件規模の高速同期に対応
• サーバー側ブルートフォース保護とセキュリティ隔離 | -👉 全 17 の実機スクリーンショットと解説を見る：**[完全な活用シーンとショーケースガイド](docs/best-practices.md)** +👉 全 18 の実機スクリーンショットと解説を見る：**[完全な活用シーンとショーケースガイド](docs/best-practices.md)** ## 導入 diff --git a/README.md b/README.md index afa1c17c..66c6cf05 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ An all-in-one workspace connecting inspiration capture, deep creation, and knowl | **AI & Ecosystem** | • Companion sidebar AI assistant for summaries, proofreading & translations
• BYOK (Bring Your Own Key): compatible with OpenAI, Claude, Gemini & custom endpoints | • **Native Agent Protocols (MCP & ACP)**: Built-in MCP for external agent read/write; ACP in desktop app to drive local coding agents directly
• **AI RSS Daily Digest**: Automated feed aggregation, AI noise filtering, and structured digest generation
• Extensible Plugin Development API | | **Multi-Device Sync & Foundation** | • Seamless, low-latency sync across desktop, mobile, and web with zero device limits
• Official client support across Web, macOS, Windows, Linux, iOS, and Android
• Offline-first with auto-sync queue: write smoothly offline, automatically resume and sync when reconnected
• Standard SQLite database, lossless ZIP backup & Markdown export/import | • **Zero Server Cost for Life**: 100% runnable on Cloudflare Free tier (~150k short notes & ~50k images)
• **Flexible Docker Self-Hosting**: One-click deployment for VPS, NAS, or home server with millions of notes & instant sync
• Server-side brute-force protection and tenant security | -👉 Explore all 17 step-by-step showcases with screenshots: **[Complete Showcase & Workflows Guide](docs/best-practices.md)** +👉 Explore all 18 step-by-step showcases with screenshots: **[Complete Showcase & Workflows Guide](docs/best-practices.md)** ## Deployment diff --git a/README.pl-PL.md b/README.pl-PL.md index 3fb6ae6c..0b5e09e0 100644 --- a/README.pl-PL.md +++ b/README.pl-PL.md @@ -90,7 +90,7 @@ Wszechstronny obszar roboczy łączący zbieranie inspiracji, głębokie tworzen | **AI i ekosystem** | • Asystent AI w panelu bocznym do streszczeń, korekty, tłumaczeń i redakcji
• Własne klucze API (BYOK): zgodność z OpenAI, Claude, Gemini i serwerami proxy | • **Protokoły MCP i ACP**: Wbudowany MCP do odczytu/zapisu przez agentów zewnętrznych; ACP w aplikacji desktopowej do współpracy z lokalnymi agentami
• **Inteligentne podsumowania RSS AI**: Agregacja źródeł, filtrowanie szumu i generowanie zwięzłych podsumowań
• API tworzenia wtyczek do rozbudowy funkcji | | **Synchronizacja i fundament** | • Natychmiastowa synchronizacja bez opóźnień na komputerach, telefonach i w sieci bez limitu urządzeń
• Oficjalne aplikacje na Web, macOS, Windows, Linux, iOS i Android
• Architektura offline-first i kolejka synchronizacji: płynne pisanie bez sieci, automatyczna synchronizacja po połączeniu
• Standardowa baza SQLite, bezstratny eksport/import archiwów ZIP i Markdown | • **Zero kosztów serwera na zawsze**: 100% działania w darmowym planie Cloudflare (~150 tys. notatek i ~50 tys. obrazów)
• **Elastyczny hosting Docker**: Wdrożenie na VPS, NAS lub domowym serwerze dla milionów notatek z natychmiastową synchronizacją
• Ochrona serwera przed atakami brute-force i bezpieczna izolacja | -👉 Wszystkie 17 scenariuszy ze zrzutami ekranu opisuje [pełny przewodnik po funkcjach i zastosowaniach](docs/best-practices.md). +👉 Wszystkie 18 scenariuszy ze zrzutami ekranu opisuje [pełny przewodnik po funkcjach i zastosowaniach](docs/best-practices.md). ## Wdrożenie diff --git a/README.zh-CN.md b/README.zh-CN.md index 2d6c148e..3e3e61df 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -90,7 +90,7 @@ EdgeEver 是一款现代化的开源笔记与个人知识库工作区。它保 | **AI 与生态** | • 侧边伴随式 AI 助手，选区/全文一键总结、翻译与润色
• BYOK（自带模型）：兼容 OpenAI、Anthropic、Gemini 等主流协议 | • **原生 Agent 协议互联**：内置 MCP（外部 Agent 读写笔记）与 ACP（桌面端直接唤起本机 Agent 协作创作）
• **AI RSS 智能订阅日报**：定时聚合资讯源，AI 自动过滤噪音并生成精炼日报
• 开放插件开发 API 自由扩展 | | **多端同步与底座** | • 电脑、手机全端秒级无感同步，无设备数量限制
• 官方覆盖 Web / macOS / Windows / Linux / iOS / Android 全平台
• 离线优先与同步队列：断网流畅写作，联网自动恢复并增量同步
• 标准 SQLite 存储，无损 ZIP 档案与 Markdown 导出导入 | • **终身零服务器成本**：100% 运行于 Cloudflare 免费配额（容量约 15 万条短笔记与 5 万张图片）
• **灵活 Docker 自托管**：私有 VPS/NAS 一键部署，轻松承载百万级笔记与瞬时同步
• 服务端防暴力破解限流保护与安全数据隔离 | -👉 查看全部 17 个实机演示与操作效果：**[完整场景与最佳实践指南](docs/best-practices.zh-CN.md)** +👉 查看全部 18 个实机演示与操作效果：**[完整场景与最佳实践指南](docs/best-practices.zh-CN.md)** ## 部署 diff --git a/README.zh-TW.md b/README.zh-TW.md index 014604c0..498cf268 100644 --- a/README.zh-TW.md +++ b/README.zh-TW.md @@ -90,7 +90,7 @@ EdgeEver 是一款現代化的開源筆記與個人知識庫工作區。它延 | **AI 與生態** | • 側邊伴隨式 AI 助手，選取範圍/全文一鍵摘要、翻譯與修飾潤色
• BYOK（自備金鑰）：相容 OpenAI、Anthropic、Gemini 等主流協定 | • **原生 Agent 協定互聯**：內建 MCP（外部 Agent 讀寫筆記）與 ACP（桌面端直接喚起本機 Agent 協同創作）
• **AI RSS 智慧訂閱日報**：定時聚合資訊來源，AI 自動過濾雜訊並產生精煉日報
• 開放外掛開發文件自由擴充 | | **多端同步與底座** | • 電腦、手機全端秒級無感同步，無裝置數量限制
• 官方涵蓋 Web / macOS / Windows / Linux / iOS / Android 全平台
• 離線優先與同步佇列：斷網流暢寫作，連網自動復原並增量同步
• 標準 SQLite 儲存，無損 ZIP 封存與 Markdown 匯出匯入 | • **終身零伺服器成本**：100% 執行於 Cloudflare 免費配額（容量約 15 萬條短筆記與 5 萬張圖片）
• **彈性 Docker 自託管**：私有 VPS/NAS 一鍵部署，輕鬆承載百萬級筆記與瞬時同步
• 伺服端防暴力破解限流保護與安全資料隔離 | -👉 查看全部 17 個實機展示與操作效果：**[完整場景與最佳實踐指南](docs/best-practices.zh-CN.md)** +👉 查看全部 18 個實機展示與操作效果：**[完整場景與最佳實踐指南](docs/best-practices.zh-CN.md)** ## 部署 diff --git a/docs/assets/best-practices/original-image/note-export-image/clear-theme.png b/docs/assets/best-practices/original-image/note-export-image/clear-theme.png new file mode 100644 index 00000000..323a1174 Binary files /dev/null and b/docs/assets/best-practices/original-image/note-export-image/clear-theme.png differ diff --git a/docs/assets/best-practices/original-image/plugin/ai-daily.png b/docs/assets/best-practices/original-image/plugin/ai-daily.png new file mode 100644 index 00000000..39488502 Binary files /dev/null and b/docs/assets/best-practices/original-image/plugin/ai-daily.png differ diff --git a/docs/assets/best-practices/original-image/plugin/official-in.png b/docs/assets/best-practices/original-image/plugin/official-in.png new file mode 100644 index 00000000..69b56ae8 Binary files /dev/null and b/docs/assets/best-practices/original-image/plugin/official-in.png differ diff --git a/docs/assets/best-practices/rss-daily-exported-poster.png b/docs/assets/best-practices/rss-daily-exported-poster.png deleted file mode 100644 index adb0aa02..00000000 Binary files a/docs/assets/best-practices/rss-daily-exported-poster.png and /dev/null differ diff --git a/docs/assets/best-practices/rss-daily-menu-share-image.png b/docs/assets/best-practices/rss-daily-menu-share-image.png deleted file mode 100644 index 5d55f6d6..00000000 Binary files a/docs/assets/best-practices/rss-daily-menu-share-image.png and /dev/null differ diff --git a/docs/assets/best-practices/rss-daily-poster-modal.png b/docs/assets/best-practices/rss-daily-poster-modal.png deleted file mode 100644 index a824abfa..00000000 Binary files a/docs/assets/best-practices/rss-daily-poster-modal.png and /dev/null differ diff --git a/docs/best-practices.md b/docs/best-practices.md index 8f043f97..70a20455 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -25,10 +25,13 @@ A practical guide to core workflows, key features, and real-world usage scenario - [14. Connecting Local Agents via ACP for Note Interaction](#14-connecting-local-agents-via-acp-for-note-interaction) ### Visual Styling & Omnichannel Publishing -- [15. AI RSS Daily Digest & Long Image Sharing](#15-ai-rss-daily-digest--long-image-sharing) +- [15. Note Export to Long Image & Code Cards](#15-note-export-to-long-image--code-cards) - [16. Social Media Poster & Cover Design from Notes](#16-social-media-poster--cover-design-from-notes) - [17. Copying Notes to WeChat Official Account & Blogs](#17-copying-notes-to-wechat-official-account--blogs) +### Open Ecosystem & Extensibility +- [18. Open Plugin API & Custom Plugin Development](#18-open-plugin-api--custom-plugin-development) + --- ## Core Workspace & Focused Writing @@ -217,20 +220,16 @@ EdgeEver natively supports **ACP (Agent Client Protocol)**, allowing desktop cli ## Visual Styling & Omnichannel Publishing -### 15. AI RSS Daily Digest & Long Image Sharing +### 15. Note Export to Long Image & Code Cards -Built-in AI RSS feeds aggregate news sources and generate structured daily digest notes automatically. +EdgeEver features a built-in "Share as Image" capability to render any note into a clean, high-resolution long image for effortless sharing across social platforms, chat groups, and teams. -- **Theme Export**: Use "Share as Image" to select from 8 card themes, adjust typography and layout, and export long images or copy to clipboard. -- **Code Theme**: Includes macOS window controls, line numbers, and monospace syntax formatting for code snippets. +- **Multiple Card Themes**: Choose from 8 curated card themes (Transparent, Quote, Book Excerpt, Memo, Dark, and more) with customizable typography, font sizes, and layout options. Export high-res long images or copy directly to the clipboard. +- **Technical Code Cards**: A dedicated "Code" theme features macOS-style window controls, line numbers, and monospace syntax-highlighted typography. -| 1. Select "Share as Image" | 2. Theme & Layout Config | 3. Exported Long Image | -| :---: | :---: | :---: | -| ![Note menu click share as image](assets/best-practices/rss-daily-menu-share-image.png) | ![EdgeEver share as image poster modal](assets/best-practices/rss-daily-poster-modal.png) | ![Exported high-res RSS daily poster](assets/best-practices/rss-daily-exported-poster.png) | - -| "Code" Theme Preview | -| :---: | -| ![Code theme style configuration in share modal](assets/best-practices/original-image/note-export-image/code-theme.png) | +| 1. Card Theme Previews (e.g. Transparent) | 2. Font & Layout Customization | +| :---: | :---: | +| ![EdgeEver share as image transparent theme preview](assets/best-practices/original-image/note-export-image/clear-theme.png) | ![EdgeEver share as image font and typography settings](assets/best-practices/original-image/note-export-image/code-theme.png) | --- @@ -261,3 +260,21 @@ Select **"Copy to Official Account / Blog"** (复制到公众号 / 博客) from | 2. WeChat Official Account Editor Layout | | :---: | | ![Note pasted into WeChat MP editor layout](assets/best-practices/original-image/wechat-article-copy-to/show-in-wechat-editor.png) | + +--- + +## Open Ecosystem & Extensibility + +### 18. Open Plugin API & Custom Plugin Development + +EdgeEver features a modern client plugin API and extension manager, supporting one-click installation via GitHub repository URLs or Manifest links, with cross-device workspace synchronization between Web and Desktop. + +- **Powerful Plugin APIs**: Comprehensive APIs for bidirectional note read/write, custom DOM panels/embed blocks, unified settings management, isolated local storage, and direct invocation of workspace-configured AI models. +- **Official Open-Source Reference Implementations**: + - **Task Aggregation ([EdgeEver Tasks](https://github.com/tianma-if/edgeever-tasks))**: Aggregates Markdown todo items across all notes with status filtering and two-way source navigation. + - **AI RSS Feed Assistant ([EdgeEver AI RSS](https://github.com/tianma-if/edgeever-ai-rss))**: Automatically captures curated RSS/Atom feeds and utilizes AI to generate structured daily digest notes. +- For complete API documentation and development workflows, refer to the [EdgeEver Plugin Development Guide](plugin-development.md). + +| 1. Extension & Plugin Management Center | 2. AI Digest Note Generated by Official AI RSS Plugin | +| :---: | :---: | +| ![EdgeEver plugin marketplace and official extension management](assets/best-practices/original-image/plugin/official-in.png) | ![Structured daily digest note generated by EdgeEver AI RSS plugin](assets/best-practices/original-image/plugin/ai-daily.png) | diff --git a/docs/best-practices.zh-CN.md b/docs/best-practices.zh-CN.md index 2e33eadf..35f52691 100644 --- a/docs/best-practices.zh-CN.md +++ b/docs/best-practices.zh-CN.md @@ -25,10 +25,13 @@ - [14. 连接本机 Agent (ACP) 实现笔记协同](#14-连接本机-agent-acp-实现笔记协同) ### 排版与多渠道分发 -- [15. AI RSS 订阅日报与长图分享](#15-ai-rss-订阅日报与长图分享) +- [15. 笔记导出多主题长图与代码卡片](#15-笔记导出多主题长图与代码卡片) - [16. 笔记制作社交媒体海报与封面](#16-笔记制作社交媒体海报与封面) - [17. 复制笔记至微信公众号排版](#17-复制笔记至微信公众号排版) +### 开放生态与插件扩展 +- [18. 开放插件 API 与自定义插件开发](#18-开放插件-api-与自定义插件开发) + --- ## 核心工作区与沉浸创作 @@ -217,20 +220,16 @@ EdgeEver 支持 **ACP (Agent Client Protocol)** 协议，允许桌面端连接 ## 排版与多渠道分发 -### 15. AI RSS 订阅日报与长图分享 +### 15. 笔记导出多主题长图与代码卡片 -内置的 AI RSS 订阅功能可自动聚合订阅源资讯，生成结构清晰的日报笔记。 +EdgeEver 提供「分享为图片」功能，可将笔记直接转换为高分辨率长图，方便在社交媒体、社群或团队中优雅分发。 -- **多款样式导出**：配合「分享为图片」功能，提供 8 款卡片主题、字体与版式调整，支持导出长图或复制到剪贴板。 -- **技术代码卡片**：提供专属「代码」主题，包含 macOS 窗口控件、行号与等宽代码排版。 +- **多款卡片样式**：内置 8 款卡片主题（涵盖透明质感、金句、书摘、备忘录、黑日等），支持字体、行距与排版微调，一键导出高清长图或复制至剪贴板。 +- **技术代码卡片**：提供专属「代码」等特色主题，内置 macOS 窗口控件、行号与等宽代码排版。 -| 1. 菜单选择「分享为图片」 | 2. 配置主题与排版 | 3. 导出长图预览 | -| :---: | :---: | :---: | -| ![EdgeEver 笔记菜单点击分享为图片](assets/best-practices/rss-daily-menu-share-image.png) | ![EdgeEver 分享为图片配置弹窗](assets/best-practices/rss-daily-poster-modal.png) | ![导出的高清 RSS 日报长图](assets/best-practices/rss-daily-exported-poster.png) | - -| 「代码」主题样式预览 | -| :---: | -| ![EdgeEver 分享为图片代码风格主题效果](assets/best-practices/original-image/note-export-image/code-theme.png) | +| 1. 「透明」等多款卡片主题预览 | 2. 字体风格与排版微调 | +| :---: | :---: | +| ![EdgeEver 分享为图片透明主题卡片预览](assets/best-practices/original-image/note-export-image/clear-theme.png) | ![EdgeEver 分享为图片字体与主题排版调整](assets/best-practices/original-image/note-export-image/code-theme.png) | --- @@ -261,3 +260,21 @@ EdgeEver 支持 **ACP (Agent Client Protocol)** 协议，允许桌面端连接 | 2. 公众号后台编辑器粘贴效果 | | :---: | | ![微信公众号后台粘贴后的排版效果](assets/best-practices/original-image/wechat-article-copy-to/show-in-wechat-editor.png) | + +--- + +## 开放生态与插件扩展 + +### 18. 开放插件 API 与自定义插件开发 + +EdgeEver 内置现代插件 API 与扩展管理能力，支持通过 GitHub 仓库或 Manifest 地址一键安装扩展，配置在 Web 与桌面端跨设备隔离同步。 + +- **强大开放的插件 API**：提供文档双向读写、注册自定义 DOM 面板/嵌入块、统一设置管理、本地隔离存储以及直接调用工作区已配置的 AI 模型等完整能力。 +- **官方开源参考范式**： + - **待办任务 ([EdgeEver Tasks](https://github.com/tianma-if/edgeever-tasks))**：跨笔记自动汇总 Markdown 待办任务，支持状态过滤与一键定位跳转回原笔记。 + - **AI RSS 订阅助手 ([EdgeEver AI RSS](https://github.com/tianma-if/edgeever-ai-rss))**：自动抓取精选 RSS/Atom 订阅源，结合 AI 生成分类清晰的每日简报笔记。 +- 更多 API 规范与接入指南详见 [EdgeEver 插件开发指南](plugin-development.zh-CN.md)。 + +| 1. 插件与主题管理中心 | 2. 官方 AI RSS 插件生成的日报笔记效果 | +| :---: | :---: | +| ![EdgeEver 插件市场与官方插件管理](assets/best-practices/original-image/plugin/official-in.png) | ![EdgeEver AI RSS 插件自动生成的结构化日报笔记](assets/best-practices/original-image/plugin/ai-daily.png) |