mirror of
https://github.com/AppFlowy-IO/AppFlowy.git
synced 2024-08-30 18:12:39 +00:00
Merge pull request #870 from LucasXu0/documentation/flowy_editor
docs: readme
This commit is contained in:
Lucas.Xu
GitHub
commit
b8b2de2dd5
@ -1,11 +1 @@
|
||||
## 0.0.1
|
||||
|
||||
* 实现基础的编辑器样式
|
||||
* heading
|
||||
* bold / 斜体 / underline / 删除线
|
||||
* checkbox
|
||||
* bulleted list
|
||||
* 实现可扩展的编辑器框架
|
||||
* IME 的支持
|
||||
* 样式的复制粘贴
|
||||
* slash 快捷输入
|
||||
|
||||
@ -17,14 +17,14 @@ and the Flutter guide for
|
||||
|
||||
|
||||
<div align="center">
|
||||
<img src="documentation/images/example.png" width = "900"/>
|
||||
<img src="https://raw.githubusercontent.com/AppFlowy-IO/AppFlowy/main/frontend/app_flowy/packages/appflowy_editor/documentation/images/example.png" width = "900"/>
|
||||
</div>
|
||||
|
||||
## Key Features
|
||||
|
||||
* Allow you to build rich, intuitive editors
|
||||
* Design and modify it your way by customizing components, shortcut events, and many more coming soon including menu options and themes
|
||||
* [Test-covered](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/documentation/testing.md) and maintained by AppFlowy's core team along with a community of more than 1,000 builders
|
||||
* [Test-covered](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/documentation/testing.md) and maintained by AppFlowy's core team along with a community of more than 1,000 builders
|
||||
|
||||
|
||||
## Getting started
|
||||
@ -67,24 +67,24 @@ flutter run
|
||||
|
||||
## How to customize
|
||||
### Customize a component
|
||||
Please refer to [customizing a component](documentation/customizing.md#customizing-a-custom-component) for more details.
|
||||
Please refer to [customizing a component](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/documentation/customizing.md#customize-a-component) for more details.
|
||||
|
||||
|
||||
### Customize a shortcut event
|
||||
Please refer to [customizing a shortcut event](documentation/customizing.md#customizing-a-custom-shortcut-event) for more details.
|
||||
Please refer to [customizing a shortcut event](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/documentation/customizing.md#customize-a-shortcut-event) for more details.
|
||||
|
||||
## More Examples
|
||||
* Customize a component
|
||||
* [Checkbox Text](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart) shows you how to extend new styles based on existing rich text components
|
||||
* [Image](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/example/lib/plugin/image_node_widget.dart) teaches you how to extend a new node and render it
|
||||
* And more examples on [rich-text plugins](https://github.com/LucasXu0/AppFlowy/tree/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text)
|
||||
* [Checkbox Text](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart) shows you how to extend new styles based on existing rich text components
|
||||
* [Image](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/example/lib/plugin/network_image_node_widget.dart) teaches you how to extend a new node and render it
|
||||
* And more examples on [rich-text plugins](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text)
|
||||
* Customize a shortcut event
|
||||
* [BIUS](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart) shows you how to make text bold/italic/underline/strikethrough through shortcut keys
|
||||
* [Paste HTML](https://github.com/LucasXu0/AppFlowy/blob/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/copy_paste_handler.dart) gives you an idea on how to handle pasted styles through shortcut keys
|
||||
* Need more examples? Check out [Internal key event handlers](https://github.com/LucasXu0/AppFlowy/tree/documentation/appflowy_editor/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers)
|
||||
* [BIUS](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart) shows you how to make text bold/italic/underline/strikethrough through shortcut keys
|
||||
* [Paste HTML](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/copy_paste_handler.dart) gives you an idea on how to handle pasted styles through shortcut keys
|
||||
* Need more examples? Check out [Internal key event handlers](https://github.com/AppFlowy-IO/AppFlowy/blob/main/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers)
|
||||
|
||||
## Glossary
|
||||
Please refer to the API documentation (link).
|
||||
Please refer to the API documentation.
|
||||
|
||||
## Contributing
|
||||
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please look at [CONTRIBUTING.md](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) for details.
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
# Contributing
|
||||
|
||||
## Reporting Bugs
|
||||
Please click this [link](https://github.com/AppFlowy-IO/AppFlowy/issues/new?assignees=&labels=bug,editor&template=bug_report.md&title=%5BFlowyEditor%20Bug%5D+Untitled+Bug+Issue) to report bugs.
|
||||
|
||||
|
||||
|
||||
## Technical Discussion And Support
|
||||
Discord link ...
|
||||
|
||||
## Submitting Pull Request
|
||||
|
||||
We welcome and appreciate your pull request submissions, and we have many good-first-issue-for-devs or help-wanted issues that we welcome you to implement.
|
||||
|
||||
As [README](../README.md) said, we want to make sure that the code you submit will not affect the existing code logic and functionality, so please attach the corresponding test for each PR submission, and it is recommended to add a brief description of the test case and scope to the test. For more details, please see [TESTING.md](./testing.md)
|
||||
|
||||
Finally, to repeat, since the AppFlowyEditor is a community-driven open source editor, we take every PR seriously and feel very much for everyone's contribution.
|
||||
@ -6,8 +6,7 @@ import 'package:flutter/material.dart';
|
||||
/// and size of the selection.
|
||||
///
|
||||
/// The widget returned by NodeWidgetBuilder must be with [Selectable],
|
||||
/// otherwise the [FlowySelectionService] will not work properly.
|
||||
///
|
||||
/// otherwise the [AppFlowySelectionService] will not work properly.
|
||||
mixin Selectable<T extends StatefulWidget> on State<T> {
|
||||
/// Returns the [Selection] surrounded by start and end
|
||||
/// in current widget.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user