Skip to content

Commit

Permalink
chore(docs): modify README
Browse files Browse the repository at this point in the history
  • Loading branch information
pubuzhixing8 committed Jun 21, 2021
1 parent 3c6d2d3 commit 339f824
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 13 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,21 @@ Slate-angular is inspired by slate-react, and try to keep the style of slate and

[Try out our live demo](http://slate-angular.ngnice.com)

![editor-preview.png](https://cdn.worktile.com/open-sources/slate-angular/editor-preview.png)
![editor-preview.png](https://cdn.worktile.com/open-sources/slate-angular/editor-preview.gif)


## Feature

- Cursor before and after for block elements
- Custom Element Compoent
- Custom Text Component
- Custom Leaf Component
- Support element front and rear cursor scheme
- Support custom component/template rendering Element
- Support custom component/template to render Text
- Support custom component/template rendering Leaf
- Support decorate decoration
- Support void element

### Compatible browser

Chrome、Edge、Safari、Firefox、QQ Browser


## Who is using slate-angular?
Expand Down Expand Up @@ -66,9 +72,9 @@ npm run test // run unit tests

### Prerequisites

Angular >= 10.2.4
Angular >= 10.*

Slate >= 0.58.4
Slate >= 0.63.0


## Contributing
Expand Down
19 changes: 13 additions & 6 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,22 @@ slate-angular 以 slate-react 为灵感,并且尽量保持 slate 和 angular

[Try out our live demo](http://slate-angular.ngnice.com)

![editor-preview.png](https://cdn.worktile.com/open-sources/slate-angular/editor-preview.png)
![editor-preview.png](https://cdn.worktile.com/open-sources/slate-angular/editor-preview.gif)


### 功能

- 支持块级元素前后光标
- 支持自定义元素组件/模板
- 支持自定义文本组件/模板
- 支持自定义叶子组件/模板
- 支持Element前后光标方案
- 支持自定义组件/模版渲染Element
- 支持自定义组件/模版渲染Text
- 支持自定义组件/模版渲染Leaf
- 支持decorate装饰
- 支持void元素

### 兼容浏览器

Chrome、Edge、Safari、Firefox、QQ Browser



## 谁在使用 slate-angular?
Expand Down Expand Up @@ -68,7 +75,7 @@ npm run test // 执行单元测试

Angular >= 10.2.4

Slate >= 0.58.4
Slate >= 0.63.0


## 贡献代码
Expand Down

0 comments on commit 339f824

Please sign in to comment.