Rhino Editor 使用与启动教程

1. 项目介绍

Rhino Editor 是一个为 Ruby on Rails 应用程序设计的富文本编辑器集成。它可以与 ActionText 后端兼容，并提供了一个所见即所得（WYSIWYG）的编辑体验。该项目目前通过 TipTap 进行集成，并计划支持 ProseMirror，以便同时支持 Markdown 和富文本编辑。

2. 项目快速启动

在开始之前，请确保您的开发环境中已安装以下依赖项：

• Ruby 3.1.2
• Rails 7.0.4
• PNPM
• Playwright
• Node.js 版本 16 或以上
• Docker（用于运行模拟的 S3 服务器）
• Docker 虚拟化工具（例如 Orbstack 或 Docker Desktop）
• Overmind（可选，用于提升开发体验）

以下是快速启动的步骤：

首先，克隆项目仓库：

git clone https://github.com/konnorrogers/rhino-editor.git
cd rhino-editor

接着，安装项目依赖：

pnpm run setup

启动服务：

使用 Overmind：

在两个终端中分别执行以下命令：

# Terminal 1
pnpm run start

# Terminal 2
cd tests/rails
overmind start -f Procfile.dev

然后访问 localhost:5100。

如果不使用 Overmind：

在三个不同的终端中分别执行以下命令：

# Terminal 1
bin/vite dev --clobber

# Terminal 2
bin/rails s

# Terminal 3
docker compose up --build

然后访问 localhost:5100。

3. 应用案例和最佳实践

在您的 Rails 应用中使用 Rhino Editor，您可以提供一个直观的编辑体验，让用户能够轻松地格式化文本和插入媒体。以下是一些最佳实践：

• 确保在您的 Rails 应用的 Gemfile 中添加了必要的依赖，并执行了 bundle install。
• 在您的 Rails 视图文件中使用 contenteditable 属性，以便集成 Rhino Editor。
• 利用 Rhino Editor 提供的 API 和插件，以扩展编辑器的功能。

4. 典型生态项目

Rhino Editor 的生态系统中，以下是一些可能的项目，它们与 Rhino Editor 互补：

• Markdown 编辑器扩展：通过集成 ProseMirror，可以开发支持 Markdown 的编辑器。
• 表格编辑插件：为 Rhino Editor 开发一个表格编辑插件，以支持复杂的文本结构。
• 嵌入式媒体处理：开发插件以支持在编辑器中嵌入视频、音频和图片等媒体内容。

通过这些模块的集成和扩展，Rhino Editor 能够更好地服务于 Ruby on Rails 开发者社区，提供更加丰富和灵活的编辑体验。