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, которое хранит данные локально. Оно позволяет быстро сохранять разрозненные фрагменты: текст, голосовые записи, скриншоты, ссылки или файлы, а позже с помощью ИИ упорядочить их в структурированные заметки.
Это самостоятельное приложение или плагин для другого редактора?Это самостоятельное кроссплатформенное приложение, созданное на Tauri для компьютеров и с нативными сборками для мобильных устройств, а не плагин и не библиотека. Ваши заметки остаются обычными файлами Markdown, которые можно открыть в любом другом редакторе или хранить в Git.
Как его запустить?Скачайте сборку для своей платформы (Windows, macOS на Apple Silicon или Intel, Linux в формате AppImage, DEB или RPM, APK для Android либо подключитесь к iOS через TestFlight), а затем выберите рабочую папку, где будут храниться ваши файлы Markdown.
Нужно ли настраивать провайдера ИИ, прежде чем начать пользоваться приложением?Нет, заметки можно создавать и писать без какой-либо настройки ИИ. Функции ИИ — упорядочивание записей, чат, эмбеддинги, OCR или работа с аудио — требуют подключения собственного провайдера ИИ и моделей.
Все ли сборки для платформ готовы к ежедневному использованию?Сборки для Windows, macOS и Linux помечены как Beta, сборка для Android — как Alpha (только ARM64), а iOS — как Alpha и доступна только через TestFlight, поэтому поддержка мобильных платформ пока на раннем этапе.
Где на самом деле хранятся мои данные?Заметки — это обычные файлы Markdown, которые сначала сохраняются локально, в выбранной вами рабочей папке. Синхронизация с облаком (GitHub, GitLab, Gitee, Gitea, хранилища, совместимые с S3, или WebDAV) необязательна, а вместо нее можно вести только локальные резервные копии.
Чем рабочая область Canvas отличается от редактора Markdown?Canvas — это отдельная визуальная рабочая область для блок-схем, интеллект-карт, таймлайнов, рисунков от руки и диаграмм данных, в том числе диаграмм, созданных по содержимому заметок. Элементы остаются редактируемыми после создания, даже те, что предложил ИИ.
Для чего нужна база знаний?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