codexu/note-gen

NoteGen – AI‑enhanced local‑first Markdown note‑taking

What it is — A desktop‑and‑mobile app that lets you quickly capture ideas (text, voice, screenshots, links, files, etc.) and later organise them into structured Markdown notes. The core data are ordinary .md files stored in a folder you choose, so you can edit them with any editor or keep them in Git.

Why AI matters — You plug in any compatible LLM provider (OpenAI, Claude, Gemini, etc.) and use the model for:

• Summarising or re‑structuring a selection of captured records into a note template.
• Continuing, shortening, expanding, translating or polishing existing text.
• Answering questions that draw on your own notes, a vector‑based knowledge base, or attached images (OCR, embeddings, reranking).
• Generating diagrams, charts or mind‑maps from note content.
• Running longer, multi‑step “Agent” workflows. The AI output is always editable; you stay in control of the final wording.

Key workflow

1. Capture – add a thought, voice memo, screenshot, link, file, or todo without worrying about titles or folders.
2. Select – filter records by tag, time or type and pick the ones that belong together.
3. Organise – pick a template or describe the desired output; the AI builds a Markdown draft (summary, report, article, etc.).
4. Edit – refine the draft in the built‑in visual/editor mode and continue writing.

Main features

• Full‑featured Markdown editor (tables, task lists, code blocks, math, diagrams, source/visual mode, search‑replace, history).
• Canvas workspace for flowcharts, mind maps, timelines, freehand drawings and data charts, all editable after AI generation.
• Local‑first storage with optional sync via GitHub/GitLab/Gitee/Gitea, S3, WebDAV, or manual backups.
• Knowledge‑base layer: vector indexing, hybrid retrieval, configurable embedding/reranking models, long‑term memory, reusable prompts, MCP servers, installable Skills, and Agent tools.
• Extensible plugin system (TypeScript SDK, marketplace, official plugins).
• Multi‑platform: Windows, macOS, Linux (beta), Android & iOS (alpha) with downloadable installers and GitHub releases.

Who might use it

• Researchers or students who collect snippets and later need structured notes.
• Professionals who record meetings, screenshots and to‑dos and want quick reports.
• Anyone who prefers plain‑text Markdown but wants AI‑assisted summarisation, translation, or diagram generation.

How to get started

1. Download the appropriate installer from the website or GitHub releases.
2. Choose a folder as your Markdown workspace.
3. Add a first record (text, voice, image, etc.).
4. Configure an AI provider (API key) when you want to use AI features.
5. Follow the online docs for sync, knowledge‑base setup, or plugin development.

Open‑source status — The core app, server sync component, browser clipper, plugin SDK and official plugins are all under GPL‑v3, with a public contribution guide and active issue/discussion channels.

---

All details are taken directly from the repository’s README.