You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The core philosophy is to combine recording, writing, and AI, with all three complementing each other. The recording function helps users quickly capture and organize fragmented knowledge. The organization function is the bridge connecting recording and writing, which can organize continuously recorded content into a readable note, assisting users in completing the creation process from scratch. If the AI-organized results cannot meet your requirements, you can use the writing function to refine it yourself.
18
16
19
-
## Features
17
+
## Screenshots
20
18
21
-
> [!IMPORTANT]
22
-
> NoteGen is still in the development stage and has many limitations and defects.
19
+
Writing:
23
20
24
-
The core philosophy of NoteGen is to combine recording, writing, and AI, with all three complementing each other. The recording function helps users quickly capture and organize fragmented knowledge. The organization function is the bridge connecting recording and writing, which can organize continuously recorded content into a readable note, assisting users in completing the creation process from scratch. If the AI-organized results cannot meet your requirements, you can use the writing function to refine it yourself.
1. 🖥️ Screenshot recording, through which users can quickly capture and record fragmented knowledge, especially in situations where text copying is not possible.
31
-
2. 📄 Text recording, which allows copying text or manually inputting brief content as a record.
32
-
3. 🖼️ Illustration recording, which can be automatically inserted into appropriate positions when generating notes.
33
-
4. 📇 File recording, which recognizes content from PDF, md, html, txt, and other files for text recording.
34
-
5. 🔗 Link recording (to be implemented), using web crawlers for page content recognition and recording.
35
-
6. 📷 Photo recording (to be implemented), similar to illustration recording, calling the camera to record, suitable for future mobile use.
- 🏷️ Custom tags for better categorization and differentiation of different recording scenarios.
40
-
- 🤖 AI conversation, by default associated with records under the current tag, and you can also manually associate it with any article in your writing.
41
-
- 📋 Clipboard recognition, which automatically recognizes images or text in the clipboard after you copy them.
42
-
- 💾 Organization, when you have completed a series of records, you can try to let AI help you organize them into an article.
31
+
## Recording
43
32
44
-
### Writing
33
+
Supported recording methods:
45
34
46
-
- 🗂 File manager, supporting management of files and folders in local and Github repositories, with unlimited directory levels.
47
-
- 📝 Support for WYSIWYG, instant rendering, and split-screen preview modes.
48
-
- 📅 Version control, if you enable synchronization, you can trace back to historically uploaded records in the history.
49
-
- 🤖 AI assistance, supporting Q&A, continuation, optimization, simplification, translation, and other functions, and you can insert records into any position of the article at any time.
50
-
- 🏞️ Image hosting, directly copy and paste images into the Markdown editor, which will automatically upload the image to the image hosting service and convert it to a Markdown image link.
51
-
- 🛠️ HTML and Markdown conversion, copying content from browsers will automatically convert it to Markdown format.
35
+
1. 🖥️ Screenshot recording: Users can quickly capture and record fragmented knowledge through screenshots, especially in situations where text cannot be copied.
36
+
2. 📄 Text recording: You can copy text or manually input brief content as a record.
37
+
3. 🖼️ Illustration recording: Can be automatically inserted into appropriate positions when generating notes.
38
+
4. 📇 File recording: Recognize content from PDF, MD, HTML, TXT, and other file types for text recording.
39
+
5. 🔗 Link recording (coming soon): Use web crawlers to identify and record page content.
40
+
6. 📷 Photo recording (coming soon): Similar to illustration recording, it uses the camera to record, suitable for future mobile use.
52
41
53
-
### Auxiliary
42
+
Assistive recording features:
54
43
55
-
- 📦 Large model support, with multiple built-in large model configurations, supporting customization and easy switching.
56
-
- 👁️ OCR, which can assist in recognizing text in images.
57
-
- 🏗️ Organization templates, which can be customized for AI to organize different types of content.
58
-
- 🔎 Global search, for quickly searching and jumping to specified content.
59
-
- 🌃 Image hosting management, for convenient management of image hosting repository content.
60
-
- 💎 Themes and appearance, supporting dark theme, and appearance settings for Markdown, code, etc.
44
+
- 🏷️ Custom tags: Better categorize and distinguish different recording scenarios.
45
+
- 🤖 AI conversation: By default, it associates with records under the current tag, but you can also manually associate with any article in your writing section.
46
+
- 🤪 Personas: Support custom prompts to precisely control your AI assistant.
47
+
- 📋 Clipboard recognition: Automatically recognizes images or text in your clipboard after copying.
48
+
- 💾 Organization: When you've completed a series of records, you can have AI organize them into an article.
61
49
62
-
## How to Use?
50
+
## Writing
63
51
64
-
### Download
52
+
- 🗂 File manager: Supports file and folder management for both local and GitHub repositories, with unlimited directory hierarchy.
53
+
- 📝 Supports WYSIWYG, instant rendering, and split-screen preview modes.
54
+
- 📅 Version control: If you enable the sync feature, you can trace back to previously uploaded records in the history.
55
+
- 🤖 AI assistance: Supports Q&A, continuation, optimization, simplification, translation, and other functions, and you can insert records into any position in your article at any time.
56
+
- 🏞️ Image hosting: Directly copy and paste images into the Markdown editor, which will automatically upload the image to the image host and convert it to a Markdown image link.
57
+
- 🛠️ HTML to Markdown conversion: Browser content copied will be automatically converted to Markdown format.
65
58
66
-
Currently supports Mac, Windows, Linux, and thanks to Tauri2's cross-platform capabilities, it will support iOS and Android in the future.
Currently supports custom model configuration, with built-in support for ChatGPT, ChatAnyWhere, Ollama, LM Studio, Doubao, Tongyi Qianwen, Kimi, DeepSeek, and all models using the OpenAI protocol. Support for other protocols will be gradually added in the future.
78
+
NoteGen does not provide any services itself and requires manual configuration. It supports ChatGPT, Ollama, LM Studio, DeepSeek, and other large models by default, and also supports custom configuration of other providers' large models.
79
79
80
-
> Local models may currently experience 403 errors, waiting for a solution from http-plugin. This issue does not occur in the development environment.
80
+
### Sync and Image Hosting
81
81
82
-
[Discussion Topic - About Model Integration](https://github.com/codexu/note-gen/discussions/26)
82
+
NoteGen supports offline storage, with all notes stored in Markdown format. To ensure the security of your notes, you can choose to sync them to a private GitHub repository. After configuring synchronization, it also supports GitHub image hosting functionality. In the future, it will support independent configuration of other image hosting services.
83
83
84
-
### Synchronization and Image Hosting
84
+
##Community
85
85
86
-
NoteGen supports offline storage, with all notes stored in Markdown format. To ensure the security of your notes, you can choose to synchronize them to a private Github repository. After configuring synchronization, Github image hosting functionality is also supported. Independent configuration for other image hosting services will be supported in the future.
86
+
Welcome to join the NoteGen community group, where you can ask questions, share usage experiences, or suggest improvements. You can also join to learn about Tauri and discuss it with me.
87
+
88
+
Scan the QR code to join the [discussion group](https://github.com/codexu/note-gen/discussions/110). If the QR code expires, you can add WeChat xu461229187 to join the group.
87
89
88
90
## Contribute
89
91
@@ -93,10 +95,8 @@ NoteGen is implemented using the following technology stack:
0 commit comments