Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: modify Fluent Editor to TinyEditor #212

Merged
merged 2 commits into from
Jan 17, 2025
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 🐛 Bug report
description: Create a report to help us improve Fluent Editor
description: Create a report to help us improve TinyEditor
title: '🐛 [Bug]: '
labels: [🐛 bug]
body:
Expand Down
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing

We are delighted that you are interested in contributing to the Fluent Editor open-source project. There are many ways to contribute, and you can choose one or more based on your strengths and interests:
We are delighted that you are interested in contributing to the TinyEditor open-source project. There are many ways to contribute, and you can choose one or more based on your strengths and interests:

- Report [new issues](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
- Provide more detailed information for [existing issues](https://github.com/opentiny/fluent-editor/labels/bug), such as additional screenshots, detailed reproduction steps, or providing a minimal reproducible demo link
- Submit Pull requests to fix typos in the documentation or to make the documentation clearer and more comprehensive
- Add the official assistant WeChat: opentiny-official (note: Fluent Editor), join the technical discussion group
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join the technical discussion group

Once you have used Fluent Editor rich text and participated in several of the above forms of contributions, and have become familiar with Fluent Editor, you can try more challenging tasks, such as:
Once you have used TinyEditor rich text and participated in several of the above forms of contributions, and have become familiar with TinyEditor, you can try more challenging tasks, such as:

- Fixing bugs, starting with [good first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue)
- Implementing new features
Expand All @@ -17,7 +17,7 @@ Once you have used Fluent Editor rich text and participated in several of the ab

## Submitting Issues

If you encounter problems while using Fluent Editor, we welcome you to submit an Issue. Before submitting an Issue, please read the relevant [official documentation](https://opentiny.github.io/fluent-editor) to confirm whether it is a defect or a feature that has not yet been implemented.
If you encounter problems while using TinyEditor, we welcome you to submit an Issue. Before submitting an Issue, please read the relevant [official documentation](https://opentiny.github.io/fluent-editor) to confirm whether it is a defect or a feature that has not yet been implemented.

If it is a defect, create a new Issue using the [Bug report](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) template. Example title: `After setting and saving the background color of table cells in the table module, the background color is lost when rendering the cells next time`.

Expand All @@ -36,7 +36,7 @@ The Issue for new features mainly requires the following information:

## Submitting PRs

Before submitting a PR, please ensure that the content you submit is in line with the overall planning of Fluent Editor. Generally, Issues already marked as [bug](https://github.com/opentiny/fluent-editor/labels/bug) encourage submitting PRs. If you are not sure, you can create a [Discussion](https://github.com/opentiny/fluent-editor/discussions) for discussion.
Before submitting a PR, please ensure that the content you submit is in line with the overall planning of TinyEditor. Generally, Issues already marked as [bug](https://github.com/opentiny/fluent-editor/labels/bug) encourage submitting PRs. If you are not sure, you can create a [Discussion](https://github.com/opentiny/fluent-editor/discussions) for discussion.

### Pull Request Standards

Expand Down Expand Up @@ -71,10 +71,10 @@ The PR description uses a template and requires filling in the relevant PR infor

### Local Startup Steps

- Click the Fork button at the top right of the [Fluent Editor](https://github.com/opentiny/fluent-editor) code repository to Fork the upstream repository to your personal repository
- Click the Fork button at the top right of the [TinyEditor](https://github.com/opentiny/fluent-editor) code repository to Fork the upstream repository to your personal repository
- Clone your personal repository to the local
- Associate the upstream repository to synchronize the latest code from the upstream repository
- Run `pnpm i` in the root directory of Fluent Editor to install dependencies
- Run `pnpm i` in the root directory of TinyEditor to install dependencies
- Run `pnpm dev` to start the rich text website
- Open the browser to visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)

Expand All @@ -101,7 +101,7 @@ pnpm dev
- Local coding
- Follow the [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) standard for submission, PRs that do not conform to the submission standard will not be merged
- Submit to the remote repository: git push origin branchName
- Open the [Pull requests](https://github.com/opentiny/fluent-editor/pulls) link of the Fluent Editor code repository, click the New pull request button to submit PR
- Open the [Pull requests](https://github.com/opentiny/fluent-editor/pulls) link of the TinyEditor code repository, click the New pull request button to submit PR
- Supplement the relevant information according to the PR template, including PR checklist, PR type, associated Issue number, whether it is a destructive change
- The project Committer conducts Code Review and provides feedback
- The PR author adjusts the code according to the feedback, please note that after a branch has initiated a PR, subsequent commits will be synchronized automatically, no need to resubmit PR
Expand All @@ -113,14 +113,14 @@ The contribution process ends, thank you for your contribution!

If you are interested in our open-source projects, you are welcome to join our open-source community through the following methods.

- Add the official assistant WeChat: opentiny-official (note: Fluent Editor), join our technical discussion group
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join our technical discussion group

If you have submitted an Issue or PR for Fluent Editor, please comment the following content under the Issue or PR to add yourself to the contributor list.
If you have submitted an Issue or PR for TinyEditor, please comment the following content under the Issue or PR to add yourself to the contributor list.

```
@all-contributors please add @<username> for <contributions>
```

For detailed rules, please refer to: [https://allcontributors.org/docs/en/bot/usage](https://allcontributors.org/docs/en/bot/usage)

We sincerely thank every developer who has contributed to the Fluent Editor open-source project! ❤
We sincerely thank every developer who has contributed to the TinyEditor open-source project! ❤
24 changes: 12 additions & 12 deletions CONTRIBUTING.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# 贡献指南

很高兴你有意愿参与 Fluent Editor 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个:
很高兴你有意愿参与 TinyEditor 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个:

- 报告[新缺陷](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+)
- 为[已有缺陷](https://github.com/opentiny/fluent-editor/labels/bug)提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
- 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善
- 添加官方小助手微信 opentiny-official(备注:Fluent Editor),加入技术交流群参与讨论
- 添加官方小助手微信 opentiny-official(备注:TinyEditor),加入技术交流群参与讨论

当你亲自使用 Fluent Editor 富文本,并参与多次以上形式的贡献,对 Fluent Editor 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如:
当你亲自使用 TinyEditor 富文本,并参与多次以上形式的贡献,对 TinyEditor 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如:

- 修复缺陷,可以先从 [Good-first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue) 开始
- 实现新特性
Expand All @@ -17,7 +17,7 @@

## 提交 Issue

如果你在使用 Fluent Editor 富文本过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.github.io/fluent-editor),确认这是一个缺陷还是尚未实现的功能。
如果你在使用 TinyEditor 富文本过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的[官方文档](https://opentiny.github.io/fluent-editor),确认这是一个缺陷还是尚未实现的功能。

如果是一个缺陷,创建新 Issue 时选择 [Bug report](https://github.com/opentiny/fluent-editor/issues/new?assignees=&labels=%F0%9F%90%9B++bug&projects=&template=bug-report.yml&title=%F0%9F%90%9B+%5BBug%5D%3A+) 模板,标题示例:`在表格模块中,设置单元格背景色并保存之后,下次渲染单元格背景色丢失`。

Expand All @@ -36,7 +36,7 @@

## 提交 PR

提交 PR 之前,请先确保你提交的内容是符合 Fluent Editor 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/fluent-editor/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/fluent-editor/discussions) 进行讨论。
提交 PR 之前,请先确保你提交的内容是符合 TinyEditor 整体规划的,一般已经标记为 [bug](https://github.com/opentiny/fluent-editor/labels/bug) 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 [Discussion](https://github.com/opentiny/fluent-editor/discussions) 进行讨论。

### Pull Request 规范

Expand Down Expand Up @@ -71,10 +71,10 @@ PR 描述使用了模板,需要按照模板填写 PR 相关信息,主要包

### 本地启动步骤

- 点击 [Fluent Editor](https://github.com/opentiny/fluent-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
- 点击 [TinyEditor](https://github.com/opentiny/fluent-editor) 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库
- Clone 个人仓库到本地
- 关联上游仓库,方便同步上游仓库最新代码
- 在 Fluent Editor 根目录下运行 `pnpm i`,安装依赖
- 在 TinyEditor 根目录下运行 `pnpm i`,安装依赖
- 运行 `pnpm dev`,启动富文本网站
- 打开浏览器访问:[http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)

Expand All @@ -101,7 +101,7 @@ pnpm dev
- 本地编码
- 遵循 [Commit Message Format](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范进行提交,不符合提交规范的 PR 将不会被合并
- 提交到远程仓库:git push origin branchName
- 打开 Fluent Editor 代码仓库的 [Pull requests](https://github.com/opentiny/fluent-editor/pulls) 链接,点击 New pull request 按钮提交 PR
- 打开 TinyEditor 代码仓库的 [Pull requests](https://github.com/opentiny/fluent-editor/pulls) 链接,点击 New pull request 按钮提交 PR
- 按照 PR 模板补充相关信息,包括 PR 自检项、PR 类型、关联的 Issue 编号、是否是破坏性变更
- 项目 Committer 进行 Code Review,并提出意见
- PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR
Expand All @@ -111,16 +111,16 @@ pnpm dev

## 加入开源社区

如果你对我们的 Fluent Editor 开源项目感兴趣,欢迎通过以下方式加入我们的开源社区。
如果你对我们的 TinyEditor 开源项目感兴趣,欢迎通过以下方式加入我们的开源社区。

- 添加官方小助手微信:opentiny-official(备注:Fluent Editor),加入我们的技术交流群
- 添加官方小助手微信:opentiny-official(备注:TinyEditor),加入我们的技术交流群

如果你给 Fluent Editor 提交过 Issue 或 PR,请在 Issue 或 PR 下面评论以下内容,添加自己到贡献者列表里。
如果你给 TinyEditor 提交过 Issue 或 PR,请在 Issue 或 PR 下面评论以下内容,添加自己到贡献者列表里。

```
@all-contributors please add @<username> for <contributions>
```

详细规则可以参考:[https://allcontributors.org/docs/en/bot/usage](https://allcontributors.org/docs/en/bot/usage)

我们诚挚感谢每位参与过 Fluent Editor 开源项目贡献的开发者们!❤
我们诚挚感谢每位参与过 TinyEditor 开源项目贡献的开发者们!❤
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 - present Fluent Editor Authors.
Copyright (c) 2024 - present TinyEditor Authors.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Fluent Editor
# TinyEditor

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

Fluent Editor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as table, image, link, clipboard, emoji, file, mention, and quick menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem.
TinyEditor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as table, image, link, clipboard, emoji, file, mention, and quick menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem.

English | [简体中文](README.zh-CN.md)

## Features

Fluent Editor has the following features and advantages:
TinyEditor has the following features and advantages:

- Contains more than 30 modules and formats, in addition to the 21 built-in formats in Quill, it also extends and enhances 15 modules and formats such as table, image, link, counter, emoji, file, clipboard, mention, quick menu, screenshot, etc.
- Powerful table function, supports inserting table with specified rows and columns in the toolbar, table row height/column width dragging, inserting rows/columns, deleting rows/columns, merging/splitting cells, and other rich table operations.
- It is not related to frameworks and can be used in multiple frameworks such as Vue, React, Angular, etc.
- Compatible with all Quill APIs, Quill ecosystem modules and formats.

![Fluent Editor](fluent-editor.png)
![TinyEditor](fluent-editor.png)

## Quick Start

Install Fluent Editor:
Install TinyEditor:

```shell
npm i @opentiny/fluent-editor
Expand All @@ -33,7 +33,7 @@ Write html:

```html
<div id="editor">
<p>Hello Fluent Editor!</p>
<p>Hello TinyEditor!</p>
</div>
```

Expand All @@ -43,7 +43,7 @@ Import style:
@import '@opentiny/fluent-editor/style.css';
```

Initialize the Fluent Editor editor:
Initialize the TinyEditor editor:

```javascript
import FluentEditor from '@opentiny/fluent-editor'
Expand Down Expand Up @@ -95,10 +95,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

Thanks to:

- The [quill](https://github.com/slab/quill) project, which is an API-driven rich text editor with a modular architecture, good scalability, ease of use, and cross-platform support. Fluent Editor extends and enhances a large number of modules and formats such as tables, images, and hyperlinks based on Quill.
- The [quill-better-table](https://github.com/soccerloway/quill-better-table) project, which enhances the built-in table module of Quill and adds rich functionality. Fluent Editor's table operation functionality is based on quill-better-table.
- The [quill-emoji](https://github.com/contentco/quill-emoji) project, which is a Quill module for emoji. Fluent Editor's insert emoji function is based on quill-emoji.
- The [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) project, which is a Quill module for resizing images and videos. Fluent Editor's image scaling function is based on quill-blot-formatter.
- The [quill](https://github.com/slab/quill) project, which is an API-driven rich text editor with a modular architecture, good scalability, ease of use, and cross-platform support. TinyEditor extends and enhances a large number of modules and formats such as tables, images, and hyperlinks based on Quill.
- The [quill-better-table](https://github.com/soccerloway/quill-better-table) project, which enhances the built-in table module of Quill and adds rich functionality. TinyEditor's table operation functionality is based on quill-better-table.
- The [quill-emoji](https://github.com/contentco/quill-emoji) project, which is a Quill module for emoji. TinyEditor's insert emoji function is based on quill-emoji.
- The [quill-blot-formatter](https://github.com/Fandom-OSS/quill-blot-formatter) project, which is a Quill module for resizing images and videos. TinyEditor's image scaling function is based on quill-blot-formatter.

## License

Expand Down
14 changes: 7 additions & 7 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Fluent Editor 富文本编辑器
# TinyEditor 富文本编辑器

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

Fluent Editor 是一个基于 Quill 2.0 的富文本编辑器,在 Quill 基础上扩展了表格、图片、超链接、复制粘贴、插入表情、文件上传、@提醒、斜杆菜单等丰富的模块和格式,框架无关、兼容 Quill API、兼容 Quill 模块生态。
TinyEditor 是一个基于 Quill 2.0 的富文本编辑器,在 Quill 基础上扩展了表格、图片、超链接、复制粘贴、插入表情、文件上传、@提醒、斜杆菜单等丰富的模块和格式,框架无关、兼容 Quill API、兼容 Quill 模块生态。

[English](README.md) | 简体中文

## 项目优势

Fluent Editor 主要有以下特点和优势:
TinyEditor 主要有以下特点和优势:

- 包含 30 多种丰富的模块和格式,除了 Quill 内置的 21 种格式之外,还扩展和增强了表格、图片、超链接、字数统计、表情、文件上传、复制粘贴、@提醒、斜杆快捷菜单、截图等 15 种模块和格式
- 强大的表格功能,支持在工具栏插入指定行列的表格、表格行高/列宽拖拽、插入行/列、删除行/列、合并/拆分单元格等丰富的表格操作
- 与框架无关,可以在 Vue、React、Angular 等多种框架中使用
- 兼容 Quill 所有 API,兼容 Quill 生态模块和格式

![Fluent Editor](fluent-editor.png)
![TinyEditor](fluent-editor.png)

## 快速入门

安装 Fluent Editor
安装 TinyEditor

```shell
npm i @opentiny/fluent-editor
Expand All @@ -33,7 +33,7 @@ npm i @opentiny/fluent-editor

```html
<div id="editor">
<p>Hello Fluent Editor!</p>
<p>Hello TinyEditor!</p>
</div>
```

Expand All @@ -43,7 +43,7 @@ npm i @opentiny/fluent-editor
@import '@opentiny/fluent-editor/style.css';
```

初始化 Fluent Editor 编辑器:
初始化 TinyEditor 编辑器:

```javascript
import FluentEditor from '@opentiny/fluent-editor'
Expand Down
Loading
Loading