# note-gen **Repository Path**: qdfalcon/note-gen ## Basic Information - **Project Name**: note-gen - **Description**: No description available - **Primary Language**: Rust - **License**: MIT - **Default Branch**: dev - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2025-01-20 - **Last Updated**: 2025-02-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ![](https://github.com/codexu/note-gen/actions/workflows/release.yml/badge.svg?branch=release) ![](https://img.shields.io/github/v/release/codexu/note-gen) ![](https://img.shields.io/badge/version-alpha-orange) ![](https://img.shields.io/github/downloads/codexu/note-gen/total) ![](https://img.shields.io/github/commit-activity/m/codexu/note-gen) # NoteGen NoteGen 是一款专注于`记录`和`写作`的跨端 AI 笔记应用，基于 `Tauri` 开发。 ![](https://cdn.jsdelivr.net/gh/codexu/note-gen-image-sync@main/2c3c6211-0905-43ba-8769-4d13fd30baf4.png) ## 快速开始 ### 下载 目前支持 Mac、Windows、Linux，得益于 Tauri2 的跨平台能力，未来将支持 IOS、Android。 [下载 NoteGen (alpha)](https://github.com/codexu/note-gen/releases) ### 入门指南 如果你还不了解 NoteGen，你可以阅读使用文档，其中包含了快速上手指南： [NoteGen 使用文档](https://codexu.github.io/note-gen-help/) ### AI 模型接入 目前已支持自定义模型配置，内置 ChatGPT、ChatAnyWhere（国内代理）、Ollama、豆包、通义千问、Kimi，支持所有以 OpenAI 协议的模型，未来将逐步支持其他协议。 [话题讨论 - 关于模型接入](https://github.com/codexu/note-gen/discussions/26) ### 同步与图床 NoteGen 支持离线存储，所有笔记均以 Markdown 格式存储。为了保证笔记的安全性，你可以选择将其同步到 Github 私有仓库，配置同步后，同时支持了 Github 图床功能，未来还将支持其他图床的独立配置。 ## 特性 NoteGen 的核心理念是将记录、写作和 AI 结合使用，三者相辅相成。 它提供了强大的记录功能，帮助用户快速捕捉和整理碎片化知识。整理功能是连接记录和写作的桥梁，可将持续记录的内容整理成一篇可读的笔记，辅助用户完成从零到一的创作过程。 写作工具内置 Markdown 编辑器，支持列表大纲、数学公式、图表、流程图、甘特图、时序图、五线谱等功能。 AI 在记录中扮演了机器人的角色，你可以与它进行对话，问它与你记录有关的任何问题，也可以将它输出的内容作为记录保存下来。在写作中，AI 将扮演写作助手的角色，可以直接将输出的内容插入到编辑器中。 ### 记录 支持截图、插图和文本的多种记录方式，用户可以根据不同场景灵活选择最适合的记录形式。借助 ChatGPT 的强大功能，您无需担心记录的顺序和完整性，轻松捕捉灵感与信息，提升记录效率。 #### 工作流 NoteGen 的核心就是如何高效的记录和内容的整理，以下是从记录到自动整理为笔记的工作流： ```mermaid flowchart LR Action[记录方式] --> Scan(截图记录) --> OCR(文本识别) --> Desc[AI内容分析] --> Gen(整理文章) Action --> |上传、剪贴板|Image(插图记录) --> OCR(文本识别) --> ImageUpload(图床) --> Gen Image --> ImageAI(图像识别) --> ImageUpload(图床) Action --> |输入、剪贴板|Text(文本记录) --> Gen ``` #### 方式 1. **截图记录**是 NoteGen 的核心功能。通过截图，用户可以快速捕捉和记录碎片化知识，尤其是在遇到无法进行文本复制的情况下。其原理是通过 OCR 识别图片中的文字，再使用 ChatGPT 进行总结。 2. **文本记录**，可以确保内容的准确性，但是需要将文本复制至软件中，稍微增加了操作的复杂度。 3. **插图记录**，可以在笔记生成时，自动插入到合适的位置，你也可以复制图片，在打开 APP 时会自动识别辅助导入，如果配置了同步功能，将使用图床链接。 #### 标签 用户可以创建的标签，以便更好地归类和区分不同的记录场景。在文章生成时，这些标签及其对应的记录将会被删除（可选），从而保持内容的整洁和专注，当然其内容将在回收站中找回。 #### AI 对话 在你与 AI 对话时，默认关联当前标签下的记录，你也可以手动去关联写作内的任何文章。 #### 剪贴板识别 在你进行图片或文本复制后，切回到软件界面时，软件会自动识别剪贴板中的图片或文本，此条内容将在 AI 对话中出现，你可以将其插图到记录中。 ### 整理 整理功能作为记录与写作中间的桥梁。 当你在不断的记录中，积攒了足够的内容，你可以使用整理功能，自动将所有记录整理成一篇可读的笔记，有效节省了手动整理所需的时间。 ![](https://cdn.jsdelivr.net/gh/codexu/note-gen-image-sync@main/373d9a02-1f48-47c0-bac8-a46a4e5bc660.png) 此功能具备以下几个特点： - 支持输入个性化的需求。 - 无需关心记录顺序，由 ChatGPT 辅助你整理。 - 支持多种语言。 当你整理出一篇满意的笔记后，你可以将其转换为文章进行写作，它将笔记转换为 `.md` 文件存储于本地，并跳转至写作页面进行后续的完善工作。 ### 写作 写作模式是基于文件管理器和 Markdown 编辑器组合实现的，即使你不使用记录功能，它也可以完全独立使用。 ![](https://cdn.jsdelivr.net/gh/codexu/note-gen-image-sync@main/1694ac59-0692-4ee4-8121-de67bc3b1fbc.png) **文件管理器** 支持本地和 Github 仓库的文件和文件夹的管理，支持二级目录。 **版本管理** Github 基于 Git 实现，所以天然支持版本管理，你可以在历史记录中回溯任何时刻的记录。 **AI 辅助** 基于 AI 实现在写作时支持问答、续写、优化、精简、翻译等功能，并且可以随时将记录插入到文章任何位置。 **图床** 你可以直接复制图片粘贴在 Markdown 编辑器中，软件将自动将此图片上传至图床，并转换为 Markdown 图片链接。 **HTML 转 Markdown** 你可以更加方便的将网页上的内容复制到 Markdown 编辑器中，软件将自动将此内容转换为 Markdown 格式。 ## 贡献 目前使用以下技术栈： - [Tauri 2](https://v2.tauri.app/) - [Next.js 15](https://nextjs.org/) - [shadcn-ui](https://ui.shadcn.com/) - [Tesseract.js](https://github.com/naptha/tesseract.js) - [ChatGPT GPT-API-free](https://github.com/chatanywhere/GPT_API_free) 欢迎提交 PR 或 issue。 ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=codexu/note-gen&type=Date)](https://star-history.com/#codexu/note-gen&Date)