Knote

agent
Guvenlik Denetimi
Basarisiz
Health Gecti
  • License — License: MIT
  • Description — Repository has a description
  • Active repo — Last push 0 days ago
  • Community trust — 21 GitHub stars
Code Basarisiz
  • child_process — Shell command execution capability in electron/main.cjs
  • fs.rmSync — Destructive file system operation in electron/main.cjs
  • process.env — Environment variable access in electron/main.cjs
  • fs module — File system access in electron/main.cjs
  • network request — Outbound network request in electron/main.cjs
  • network request — Outbound network request in public/sw.js
  • fs module — File system access in scripts/readme-shots.cjs
Permissions Gecti
  • Permissions — No dangerous permissions requested

Bu listing icin henuz AI raporu yok.

SUMMARY

本地优先的类飞书 Markdown 编辑器,内置可审改的 AI 助手 | Local-first WYSIWYG Markdown editor with a reviewable AI agent

README.md

Knote

A modern, Feishu-style WYSIWYG Markdown editor with a built-in AI agent.
类飞书体验的所见即所得 Markdown 编辑器,内置可审改的 AI 助手。

Cross-platform · Local-first · Bring-your-own-AI-key
跨平台 · 本地优先 · 自带 AI 密钥

English · 中文

Knote 编辑器


中文

Knote 是一款本地优先的 Markdown 编辑器,拥有现代块编辑器(飞书 / Notion 风格)的顺滑体验,同时可配置辅助 Agent,他可以帮助你维护、修改、重构文档,你可以审改他的修改,不满意的内容可以拒绝修改。可作为网页应用、Windows 桌面应用(推荐)和 Android 应用(正在测试)运行。

演示:拖入 PDF → 生成论文总结并自动配图

https://github.com/user-attachments/assets/f9992311-e33d-4753-a1ff-96be1ba3cadf

✨ 基础功能

  • 所见即所得的编辑体验 —— 输入 Markdown 语法即时转换,一键可切到源码/预览双栏模式。
  • 丰富的 Markdown —— 标题、列表、任务、表格、带语法高亮的代码块、KaTeX 公式、脚注、Emoji、高亮/下划线等。
  • Callout 提示块 —— > [!tip]> [!warning] 等渲染为彩色卡片。
  • Mermaid 图表 —— 写 mermaid 代码块即可实时渲染流程图/时序图。
  • 标签页与文件夹工作区 —— 像浏览器一样同时打开多个文档/文件夹,可拖拽排序,重启自动恢复。浏览文件夹树、新建/重命名/删除/移动文件与文件夹,并跨文件全文搜索。
  • 查找替换Ctrl+F / Ctrl+H)、快速打开Ctrl+P)、标题折叠版本历史(一键回滚)、图片查看器(双击放大/拖拽)、界面缩放Ctrl+滚轮)。
  • 导出 PDF、Word(.doc)、HTML、Markdown。
  • 中英双语界面

🤖 AI 助手

Knote 内置 AI 助手,直接驻守在编辑器中,目标是帮你把"写、改、审、理"文档这件事变得更顺手。他不会直接修改原文,而是先把改动暂存成 diff,用户逐块或一键接受后才会生效。

AI 助手的修改以红绿 diff 呈现,逐块审核

能做什么:

  • 读文档并修改:你提出需求后,他先读取带行号的全文,再生成修改建议——支持替换、插入、续写长内容、图文混排一次成型。
  • 以 diff 形式审稿:所有修改都以红/绿 diff 暂存在文档里,你可以逐块接受/拒绝,也可以一键全部接受,避免误改原文。
  • 处理图片与 PDF:拖拽或点击附上图片 / PDF。桌面版会在本地把整份 PDF 结构化——正文转成文字、图和表格连同图注提取成可引用的元素,随消息直接发给助手;助手按需查看某张图的高清原图,并把图/表精确插入文档指定位置。网页版则退化为按页读取文字和整页截图。
  • 浏览工作区文件:当你打开文件夹时,他可以列出目录、读取其他 Markdown 文件内容,辅助跨文件整理或引用;还能批量并发处理多个文件。
  • 保持文档风格一致:修改前会先看现有格式,公式、代码块、列表层级等尽量沿用你的风格。

参考场景:

  • 生成复习资料:把 PDF 教材或课堂笔记拖拽给助手,让他生成复习资料、思维导图式提纲、Anki 卡片或 Markdown 表格,随后一边看资料一边用"问助手"追问概念。
image

示例截图,可能因版本更新稍有不同

  • 边学边问:阅读技术文档时遇到不懂的术语或公式,直接选中让助手解释、举例或补充推导过程,无需跳出编辑器去搜索。
  • 论文/报告润色:写好初稿后让助手检查逻辑断层、语法和排版,生成 diff 后逐条接受,保留自己想要的表达。
  • 会议纪要整理:把会议录音转录或手写速记丢给助手,让他提炼决议项、待办清单和责任人表格。
  • 代码文档化:选中代码块,让助手补充参数说明、示例用法,并自动生成对应 API 说明段落。
  • 多文件知识库问答:打开整个项目文件夹,让助手跨文件检索并总结某个模块的实现或历史变更。
  • 写作陪跑:卡壳时给出大纲建议、续写段落或反向提问,帮你把思路理顺。

配置:

点击右下角绿色圆球打开助手,进入设置:

  1. 选择协议 —— 多数服务选 OpenAI 兼容,Claude 官方接口选 Anthropic
  2. 填写 API 地址API Key模型名称
  3. 点击检测 —— Knote 会探测模型能力并亮起徽章(对话 / 工具 / 图片 / PDF)。

密钥仅存于浏览器本地存储;Knote 没有服务器,绝不上传。

PDF 版面分析(可选增强):桌面版设置里提供 PaddleOCR 环境的一键安装——没有安装过 Python 也没关系,Knote 会自动下载内置版 Python 并完成全部配置(全程国内镜像)。装好后,PDF 的图表提取与精确定位能力自动启用;不装也能正常使用文字读取和整页截图。

📖 三分钟上手

  1. :新建文档,直接输入 # 标题- 列表**粗体** 等语法,即时变成排版效果;Ctrl+P 快速打开文件,Ctrl+F/H 查找替换。
  2. 配助手:右下角绿色圆球 → ⚙ 设置 → 填 API 地址/Key/模型 → 点检测。
  3. 喂材料:把 PDF 或图片拖进聊天框(PDF 芯片显示"解析 x/N",✓ 后发送),或选中文档里的一段文字点"问助手"。
  4. 审改动:助手的修改以红/绿 diff 出现在文档里——绿色块右上角 ✓ 接受、✕ 拒绝,或用底部胶囊条一键处理全部。
  5. 存与导出Ctrl+S 保存;顶栏"导出"可出 PDF / Word / HTML / Markdown。

🛠 技术栈

Vue 3 · Vite · TipTap / ProseMirror · markdown-it · Tailwind CSS · daisyUI · KaTeX · Mermaid · highlight.js · Electron · Capacitor

🚀 快速开始

下载 Windows 安装包后一键安装(推荐):

前往 Releases 下载 Knote Setup x.x.x.exe,双击安装即可。

下载 Android apk 安装包(测试中):

前往 Releases 下载 .apk(如当前版本未提供,可按下方开发方式自行构建)。

本地浏览器部署(开发者):

git clone https://github.com/1661169091kiwi/Knote.git
cd Knote
npm install
npm run dev        # 打开 http://localhost:5173

# 打包 Windows 安装包
npm run dist:win   # -> release/Knote Setup <版本>.exe

# 打包 Android APK(原生工程未纳入版本库,需先生成)
npx cap add android
npm run dist:apk   # -> android/app/build/outputs/apk/debug/

📄 许可证与致谢

基于 MIT 许可证 发布。构建于诸多优秀开源项目之上(Vue、TipTap/ProseMirror、markdown-it、KaTeX、Mermaid、highlight.js、Electron、Capacitor —— 均为宽松协议)。像素字体 Press Start 2P 以 SIL 开放字体许可(OFL)使用。

"飞书"及其他产品名称为各自所有者的商标;Knote 为独立项目,与之无关联、亦未获其背书。


English

Knote is a local-first Markdown editor that feels like a modern block editor (Feishu / Notion style) while keeping plain Markdown as the single source of truth — plus a configurable AI agent that helps maintain, edit and restructure your documents. Every change it proposes is staged as a red/green diff you review and can reject. Runs as a web app, a Windows desktop app (recommended), and an Android app (in testing).

✨ Features

  • True WYSIWYG editing — type Markdown syntax and it converts live (TipTap / ProseMirror); a split source/preview mode is one click away.
  • Rich Markdown — headings, lists, tasks, tables, code blocks with syntax highlighting, KaTeX math, footnotes, emoji, highlight/underline, and more.
  • Callout blocks> [!tip], > [!warning], etc. render as colored cards.
  • Mermaid diagrams — write mermaid code blocks and see the diagram render live.
  • Built-in AI agent — connect any OpenAI-compatible or Anthropic API (DeepSeek, SiliconFlow, OpenAI, Kimi, Claude…). It reads and edits the document with every change staged as a red/green diff you accept per-block or all at once. Drag-and-drop images / PDFs; on desktop, whole PDFs are structured locally (text extracted, figures/tables cropped with captions) so the agent reads the full document and inserts exact figures. Your API key is stored only in your browser — Knote has no server.
  • Tabs & folder workspaces — open multiple documents/folders like a browser; drag to reorder; the session restores on restart. Browse a folder tree, create/rename/delete/move files, and search full-text across the whole folder.
  • Find & replace (Ctrl+F / Ctrl+H), quick open (Ctrl+P), heading fold, version history with one-click rollback, image viewer, and UI zoom (Ctrl+Wheel).
  • Export to PDF, Word (.doc), HTML, and Markdown.
  • Bilingual UI (中文 / English).

🚀 Getting started

Windows (recommended): grab Knote Setup x.x.x.exe from Releases.

Develop / run from source:

git clone https://github.com/1661169091kiwi/Knote.git
cd Knote
npm install
npm run dev        # web dev server at http://localhost:5173

npm run dist:win   # Windows installer -> release/

npx cap add android
npm run dist:apk   # Android debug APK

🤖 Configuring the AI agent

Click the green floating ball (bottom-right) to open the assistant, then open settings:

  1. Choose the protocol — OpenAI-compatible for most providers, or Anthropic for Claude's native API.
  2. Fill in API URL, API Key, and model name.
  3. Click Detect — Knote probes the model and lights up capability badges (chat / tools / vision / PDF).

Keys live in your browser's local storage only. On desktop, the optional PaddleOCR layout-analysis environment installs with one click — Knote even downloads an embedded Python automatically if none is installed.

📄 License & attributions

Released under the MIT License. Built on excellent open-source projects (Vue, TipTap/ProseMirror, markdown-it, KaTeX, Mermaid, highlight.js, Electron, Capacitor — all permissively licensed). The Press Start 2P pixel font is used under the SIL Open Font License.

"Feishu" and other product names are trademarks of their respective owners; Knote is an independent project and is not affiliated with or endorsed by them.

Yorumlar (0)

Sonuc bulunamadi