Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Notex

[中文](./README_CN.md) | English
English | [中文](./README_CN.md) | [繁體中文](./README_zh-tw.md)

<div align="center">

Expand All @@ -14,6 +14,7 @@ An AI-powered knowledge management application that lets you create intelligent
**Project URL:** https://github.com/smallnest/notex

![](docs/note2.png)

</div>

- Python clone: [pynotex](https://github.com/Beeta/pynotex)
Expand Down Expand Up @@ -84,11 +85,13 @@ EMBEDDING_MODEL=text-embedding-3-small
```

**Available OpenAI Models:**

- `gpt-4o-mini` - Fast and cost-effective (recommended)
- `gpt-4o` - Most capable
- `gpt-3.5-turbo` - Legacy option

**Tips:**

- You can also use compatible OpenAI APIs like Azure OpenAI or other providers by changing `OPENAI_BASE_URL`
- For example, to use DeepSeek: `OPENAI_BASE_URL=https://api.deepseek.com/v1` and `OPENAI_MODEL=deepseek-chat`

Expand All @@ -108,12 +111,14 @@ OLLAMA_MODEL=llama3.2
```

**Available Ollama Models:**

- `llama3.2` - Recommended balance of speed and quality
- `qwen2.5` - Excellent for Chinese content
- `mistral` - Good English performance
- `codellama` - Specialized for code

**Tips:**

- Ollama models run entirely on your machine - no data leaves your computer
- Make sure Ollama is running before starting Notex
- Larger models require more RAM and CPU
Expand Down Expand Up @@ -160,15 +165,18 @@ go build -o notex .
You can add content to your notebook in three ways:

**File Upload**

- Click the "+" button in the Sources panel
- Drag and drop or browse for files
- Supported: PDF, TXT, MD, DOCX, HTML

**Paste Text**

- Select the "Text" tab
- Enter a title and paste your content

**From URL**

- Select the "URL" tab
- Enter the URL and optional title

Expand All @@ -184,16 +192,16 @@ Click any transformation card to generate:

| Transformation | Description |
| -------------- | ------------------------------------------------------------ |
| 📝 Summary | Condensed overview of your sources |
| ❓ FAQ | Common questions and answers |
| 📚 Study Guide | Educational material with learning objectives |
| 🗂️ Outline | Hierarchical structure of topics |
| 🎙️ Podcast | Conversational script for audio content |
| 📅 Timeline | Chronological events from sources |
| 📖 Glossary | Key terms and definitions |
| ✍️ Quiz | Assessment questions with answer key |
| 📊 Infographic | Hand-drawn style visual representation of your content |
| 🧠 Mindmap | Visual hierarchical diagram of your sources using Mermaid.js |
| 📝 Summary | Condensed overview of your sources |
| ❓ FAQ | Common questions and answers |
| 📚 Study Guide | Educational material with learning objectives |
| 🗂️ Outline | Hierarchical structure of topics |
| 🎙️ Podcast | Conversational script for audio content |
| 📅 Timeline | Chronological events from sources |
| 📖 Glossary | Key terms and definitions |
| ✍️ Quiz | Assessment questions with answer key |
| 📊 Infographic | Hand-drawn style visual representation of your content |
| 🧠 Mindmap | Visual hierarchical diagram of your sources using Mermaid.js |

Or use the custom prompt field for any other transformation.

Expand Down
14 changes: 10 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ AI 驱动知识管理应用程序,让您从文档中创建智能笔记本。
**项目地址:** https://github.com/smallnest/notex

![](docs/note2.png)
</div>


</div>

- Python 版: [pynotex](https://github.com/Beeta/pynotex)

Expand Down Expand Up @@ -86,11 +85,13 @@ EMBEDDING_MODEL=text-embedding-3-small
```

**可用的 OpenAI 模型:**

- `gpt-4o-mini` - 快速且经济实惠(推荐)
- `gpt-4o` - 最强大
- `gpt-3.5-turbo` - 旧版本选项

**小贴士:**

- 您也可以通过修改 `OPENAI_BASE_URL` 来使用 Azure OpenAI 或其他兼容 OpenAI 的 API
- 例如,使用 DeepSeek:`OPENAI_BASE_URL=https://api.deepseek.com/v1` 和 `OPENAI_MODEL=deepseek-chat`

Expand All @@ -110,12 +111,14 @@ OLLAMA_MODEL=llama3.2
```

**可用的 Ollama 模型:**

- `llama3.2` - 速度和质量的推荐平衡
- `qwen2.5` - 中文内容效果优秀
- `mistral` - 英文性能良好
- `codellama` - 代码专用

**小贴士:**

- Ollama 模型完全在您的机器上运行 - 数据不会离开您的电脑
- 确保在启动 Notex 之前 Ollama 正在运行
- 更大的模型需要更多的内存和 CPU
Expand Down Expand Up @@ -162,15 +165,18 @@ go build -o notex .
您可以通过三种方式向笔记本添加内容:

**文件上传**

- 点击 Sources 面板中的 "+" 按钮
- 拖放文件或浏览选择
- 支持格式:PDF、TXT、MD、DOCX、HTML

**粘贴文本**

- 选择 "Text" 标签
- 输入标题并粘贴您的内容

**从 URL**

- 选择 "URL" 标签
- 输入 URL 和可选标题

Expand All @@ -184,8 +190,8 @@ go build -o notex .

点击任意转换卡片即可生成:

| 转换类型 | 描述 |
| ---------- | ------------------------------------------ |
| 转换类型 | 描述 |
| ----------- | ------------------------------------------ |
| 📝 摘要 | 来源的精简概述 |
| ❓ FAQ | 常见问题与答案 |
| 📚 学习指南 | 包含学习目标的教育材料 |
Expand Down
Loading
Loading