note-gen README

The project's README from github.com/codexu/note-gen. As one markdown file: README.md.

NoteGen

Capture first. Organize later.

A local-first Markdown app that helps you collect scattered information and organize it into clear notes with AI.

English · 简体中文

Documentation · Download · Business · Donate · Discussions

Release workflow Latest release GitHub stars License

NoteGen on desktop and mobile

❤️ Sponsor

Infistar.cc 无限星河

NoteGen × Infistar.cc 无限星河|全模型 API · 让记录、整理与创作更智能

感谢 Infistar.cc 无限星河赞助并为 NoteGen 提供模型服务支持!

Capture without interrupting your thoughts

An idea may begin as a sentence, a voice recording, a screenshot, or a link you do not have time to read yet. You should not have to choose a title, folder, and structure before saving it.

NoteGen separates capturing from organizing.

Save information as it appears. Later, select the records that belong together and organize them into a structured Markdown note. You can then review the result, add your own thinking, and continue writing.

The goal is not to let AI write everything for you. It is to make sure useful fragments do not disappear before you have time to turn them into something complete.

How it works

  1. Capture what happened

    Save a thought, voice recording, screenshot, image, link, file, or todo while it is still fresh.

  2. Choose the material

    Filter records by tag, time, or type, then select the items that belong together.

  3. Organize the records

    Choose a template or describe what you want to write. NoteGen can organize the selected material into a summary, report, article, or another Markdown structure.

  4. Keep writing

    Review the draft in the editor, change the structure, add details, and continue writing in your own words.

What this looks like in practice

Built around Markdown files

Your written notes remain ordinary Markdown files in the workspace you choose.

You can edit them with NoteGen, open them with another Markdown editor, keep them in Git, or move them without exporting from a proprietary format. NoteGen adds recording, AI, search, and organization around those files instead of replacing them.

The editor supports:

AI when it is useful

NoteGen connects to the AI providers and models you configure. You can use different models for chat, writing, embeddings, image recognition, OCR, and audio.

AI can help you:

AI is part of the workflow, but the result remains editable. You decide what to keep.

Search and reuse your own material

A note should remain useful after you finish writing it.

NoteGen can build a searchable knowledge base from your files and combine semantic retrieval with local text search. You can use a note, a group of records, or the knowledge base as context in a conversation instead of copying everything into a new prompt.

For advanced workflows, NoteGen also supports:

More than a document editor

NoteGen includes a canvas workspace for material that is easier to understand visually.

You can create and edit:

Canvas elements remain editable after they are created, including content suggested by AI.

Sync on your terms

Notes are stored locally first. When you need them on another device, you can sync through services you already use.

Supported options include:

You can also keep local backups without enabling cloud sync.

Download

Platform Status Download
Windows Beta Download for Windows
macOS Beta Download for Apple Silicon or Intel
Linux Beta AppImage, DEB, or RPM
Android Alpha · ARM64 Download APK
iOS Alpha Join TestFlight

GitHub Releases are also available as a fallback mirror:

View the latest GitHub Release

Get started

  1. Download NoteGen for your platform.
  2. Choose a workspace for your Markdown files.
  3. Add your first record or create a note directly.
  4. Configure an AI provider when you want to use AI features.
  5. Read the documentation for sync, knowledge base, MCP, Skills, and advanced settings.

You do not need to configure every feature before writing your first note.

Repository Purpose
note-gen-docs Official website, bilingual documentation, and download pages.
note-gen-server Sync service and account management, with support for self-hosting.
note-gen-clipper Browser extension for saving selected text, images, and page links to NoteGen.
note-gen-plugin-sdk TypeScript API, project scaffolding, CLI, and test tools for developing NoteGen plugins.
note-gen-plugins Official plugin source code and plugin marketplace publishing tools.

Contributing

NoteGen is open source and contributions are welcome.

Before opening a pull request, read the contribution guide.

You can also:

Contributors

NoteGen contributors

Thanks to everyone who has reported a problem, proposed an idea, improved a translation, written documentation, or contributed code.

Recognition

NoteGen on Trendshift Featured by HelloGitHub NoteGen on Product Hunt

Acknowledgements

NoteGen is tested with BrowserStack.

SiliconFlow provides model service support for the project.

We also appreciate the service support provided by:

License

NoteGen is released under the GNU General Public License v3.0.

note-gen (codexu/note-gen)

Searching Database…

12.9K ·GitHub
这是什么?NoteGen 是一款本地优先的 Markdown 笔记应用,可以快速记录零散的内容,比如文字、语音、截图、链接或文件,之后再借助 AI 把它们整理成结构化的笔记。
这是独立应用,还是其他编辑器的插件?它是一款基于 Tauri(桌面端)并附带原生移动端版本的独立跨平台应用,而不是插件或库。你的笔记以普通 Markdown 文件的形式保存,也可以用任何其他编辑器打开,或者放在 Git 中管理。
我该怎么把它跑起来?下载适合你平台的版本(Windows、macOS Apple Silicon/Intel、Linux AppImage/DEB/RPM、Android APK,或加入 iOS TestFlight),然后选择一个工作区文件夹,用来存放你的 Markdown 文件。
用之前我需要先配置 AI 服务商吗?不需要,不做任何 AI 设置也能记录和写笔记。整理记录、聊天、嵌入、OCR 或音频等 AI 功能则需要配置你自己的 AI 服务商和模型。
各平台版本都可以日常使用了吗?Windows、macOS 和 Linux 版本标注为 Beta,Android 为 Alpha(仅支持 ARM64),iOS 为 Alpha 且仅通过 TestFlight 提供,所以移动端支持还处于早期阶段。
我的数据到底存在哪里?笔记是普通的 Markdown 文件,首先保存在你选定的工作区本地。云同步(GitHub、GitLab、Gitee、Gitea、S3 兼容存储或 WebDAV)是可选的,你也可以只做纯本地备份。
Canvas 工作区和 Markdown 编辑器有什么不同?Canvas 是一个独立的可视化工作区,用于绘制流程图、思维导图、时间线、手绘图和数据图表,也包括根据笔记内容生成的图表;元素在创建后仍可编辑,包括 AI 推荐生成的元素。
知识库功能是做什么用的?NoteGen 可以把你的文件构建成可搜索的知识库,结合语义(向量)检索和本地文本搜索,让你可以把某篇笔记、一组记录或整个知识库作为聊天上下文使用,无需把所有内容复制粘贴到提示词中。
多设备同步是怎么工作的?由于笔记是本地优先的,同步是可选的:你可以把 NoteGen 连接到你已在使用的服务(GitHub、GitLab、Gitee、Gitea、S3 兼容存储或 WebDAV),让同一批 Markdown 文件在各设备之间保持同步。
这里的 MCP 和 Skills 支持有什么用?NoteGen 可以连接 MCP 服务器并安装 Skills,为其 Agent 模式提供额外工具,使其能处理比普通聊天更复杂的笔记整理任务。
Creator
codexu
Size
20.3 MB
Stars
12.9K
Age
2y
Commits · 90 Days