medium-ai 开源项目使用教程
1. 项目介绍
medium-ai
是一个受 medium.com
启发的开源 AI 驱动的文本编辑器。它不仅具备富文本编辑器的常规功能,还支持以下 AI 特性:
- AI 自动建议:在您开始输入时,编辑器会根据上下文生成可能的建议。您可以通过按
Ctrl + Space
生成新的建议,并从菜单中选择不同的模型进行实验。 - AI 编辑:选择文本并输入指令,编辑器会自动执行指令并更新选中的文本。
medium-ai
是一个独立项目,与 medium.com
没有任何关联。
2. 项目快速启动
2.1 克隆项目
首先,克隆 medium-ai
项目到本地:
git clone https://github.com/wingedrasengan927/medium-ai.git
2.2 前端安装
进入前端目录并安装依赖:
cd medium-ai/frontend
npm install
启动开发服务器:
npm run dev
前端将在 http://localhost:5173
上运行。
2.3 后端安装
要使用 AI 功能,需要启动后端服务。首先,创建一个 OpenAI API 密钥,并将其保存在 backend/app/config/env
文件中:
OPENAI_KEY=your_openai_api_key
安装 Anaconda 并创建虚拟环境:
conda create -n medium-ai python==3.9 anaconda
conda activate medium-ai
进入后端目录并安装依赖:
cd backend
pip install -r requirements.txt
启动后端服务器:
python main.py
后端将在 http://localhost:8080
上运行。
3. 应用案例和最佳实践
3.1 内容创作
medium-ai
特别适合内容创作者,尤其是那些希望利用 AI 生成内容建议和自动编辑功能的作者。通过 AI 自动建议功能,作者可以快速获得灵感,并通过 AI 编辑功能轻松修改文本。
3.2 技术文档编写
对于技术文档编写者,medium-ai
提供了强大的文本编辑和 AI 辅助功能。通过 AI 编辑功能,可以快速修正技术术语和语法错误,提高文档质量。
4. 典型生态项目
4.1 Lexical
medium-ai
使用 Lexical
作为文本编辑器框架,Lexical
是由 Meta 开发的开源文本编辑器框架,提供了丰富的插件和扩展功能。
4.2 DaisyUI
medium-ai
使用 DaisyUI
创建 UI 组件,DaisyUI
是一个基于 Tailwind CSS 的 UI 组件库,提供了美观且易于使用的组件。
通过这些生态项目,medium-ai
构建了一个功能强大且易于扩展的 AI 驱动的文本编辑器。