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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# Contributing
2
2
3
-
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:
3
+
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:
- 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
7
7
- Submit Pull requests to fix typos in the documentation or to make the documentation clearer and more comprehensive
8
-
- Add the official assistant WeChat: opentiny-official (note: Fluent Editor), join the technical discussion group
8
+
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join the technical discussion group
9
9
10
-
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:
10
+
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:
11
11
12
12
- Fixing bugs, starting with [good first issue](https://github.com/opentiny/fluent-editor/labels/good%20first%20issue)
13
13
- Implementing new features
@@ -17,7 +17,7 @@ Once you have used Fluent Editor rich text and participated in several of the ab
17
17
18
18
## Submitting Issues
19
19
20
-
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.
20
+
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.
21
21
22
22
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`.
23
23
@@ -36,7 +36,7 @@ The Issue for new features mainly requires the following information:
36
36
37
37
## Submitting PRs
38
38
39
-
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.
39
+
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.
40
40
41
41
### Pull Request Standards
42
42
@@ -71,10 +71,10 @@ The PR description uses a template and requires filling in the relevant PR infor
71
71
72
72
### Local Startup Steps
73
73
74
-
- 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
74
+
- 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
75
75
- Clone your personal repository to the local
76
76
- Associate the upstream repository to synchronize the latest code from the upstream repository
77
-
- Run `pnpm i` in the root directory of Fluent Editor to install dependencies
77
+
- Run `pnpm i` in the root directory of TinyEditor to install dependencies
78
78
- Run `pnpm dev` to start the rich text website
79
79
- Open the browser to visit: [http://localhost:5173/fluent-editor/](http://localhost:5173/fluent-editor/)
80
80
@@ -101,7 +101,7 @@ pnpm dev
101
101
- Local coding
102
102
- 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
103
103
- Submit to the remote repository: git push origin branchName
104
-
- 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
104
+
- 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
105
105
- Supplement the relevant information according to the PR template, including PR checklist, PR type, associated Issue number, whether it is a destructive change
106
106
- The project Committer conducts Code Review and provides feedback
107
107
- 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
@@ -113,14 +113,14 @@ The contribution process ends, thank you for your contribution!
113
113
114
114
If you are interested in our open-source projects, you are welcome to join our open-source community through the following methods.
115
115
116
-
- Add the official assistant WeChat: opentiny-official (note: Fluent Editor), join our technical discussion group
116
+
- Add the official assistant WeChat: opentiny-official (note: TinyEditor), join our technical discussion group
117
117
118
-
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.
118
+
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.
119
119
120
120
```
121
121
@all-contributors please add @<username> for <contributions>
122
122
```
123
123
124
124
For detailed rules, please refer to: [https://allcontributors.org/docs/en/bot/usage](https://allcontributors.org/docs/en/bot/usage)
125
125
126
-
We sincerely thank every developer who has contributed to the Fluent Editor open-source project! ❤
126
+
We sincerely thank every developer who has contributed to the TinyEditor open-source project! ❤
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.
9
+
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.
10
10
11
11
English | [简体中文](README.zh-CN.md)
12
12
13
13
## Features
14
14
15
-
Fluent Editor has the following features and advantages:
15
+
TinyEditor has the following features and advantages:
16
16
17
17
- 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.
18
18
- 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.
19
19
- It is not related to frameworks and can be used in multiple frameworks such as Vue, React, Angular, etc.
20
20
- Compatible with all Quill APIs, Quill ecosystem modules and formats.
21
21
22
-
22
+
23
23
24
24
## Quick Start
25
25
26
-
Install Fluent Editor:
26
+
Install TinyEditor:
27
27
28
28
```shell
29
29
npm i @opentiny/fluent-editor
@@ -33,7 +33,7 @@ Write html：
33
33
34
34
```html
35
35
<divid="editor">
36
-
<p>Hello Fluent Editor!</p>
36
+
<p>Hello TinyEditor!</p>
37
37
</div>
38
38
```
39
39
@@ -43,7 +43,7 @@ Import style:
43
43
@import'@opentiny/fluent-editor/style.css';
44
44
```
45
45
46
-
Initialize the Fluent Editor editor:
46
+
Initialize the TinyEditor editor:
47
47
48
48
```javascript
49
49
importFluentEditorfrom'@opentiny/fluent-editor'
@@ -95,10 +95,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
95
95
96
96
Thanks to:
97
97
98
-
- 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.
99
-
- 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.
100
-
- 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.
101
-
- 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.
98
+
- 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.
99
+
- 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.
100
+
- 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.
101
+
- 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.
![autofix-ci[bot]](https://avatars.githubusercontent.com/in/243519?v=4&size=40){kind=avatar}
0 commit comments