Skip to content

Commit

Permalink
docs: 📝 update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Leecason committed May 19, 2020
1 parent 4a565c0 commit 57f0b8c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 4 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ English | [简体中文](./README_ZH.md)
- 💅Many out of box [extensions](https://github.com/Leecason/element-tiptap#extensions) (welcome to submit an issue for feature request👏)
- 🔖Markdown support
- 📘TypeScript support
- 🌐I18n support(`en`, `zh`, `pl`, `ru`, `de`). welcome to contribute more languages
- 🌐I18n support(`en`, `zh`, `pl`, `ru`, `de`, `ko`). welcome to contribute more languages
- 🎈Events you might use: `init`, `transaction`, `focus`, `blur`, `paste`, `drop`, `update`
- 🍀Fully extensible, you can customize editor extension and its menu button view
- 💻Also can control the behavior of the editor directly, customize the editor for yourself.
Expand Down Expand Up @@ -118,6 +118,7 @@ Available languages:
- `pl` by @FurtakM
- `ru` by @baitkul
- `de` by @Thesicstar
- `ko` by @Hotbrains

Welcome contribution.

Expand Down Expand Up @@ -401,6 +402,22 @@ width: 700px;
height: 100%;
```

### showMenubar

Type: `boolean`

Default: `true`

Enables or disables the display of the menubar.

### charCounterCount

Type: `boolean`

Default: `true`

Enables or disables the display of the character counter.

## 👽 Events

### Init
Expand Down Expand Up @@ -512,7 +529,7 @@ I'm continuously working to add in new features 💪.
- [x] `Table` extension
- [x] `Iframe` extension
- [x] `FontType` extension
- [ ] `FontSize` extension
- [x] `FontSize` extension
- [x] `TextColor` extension
- [x] `TextHighlight` extension
- [ ] `Emoji` extension
Expand All @@ -524,3 +541,4 @@ I'm continuously working to add in new features 💪.
- [x] readonly editor
- [x] image resizable
- [ ] theme
- [ ] more detailed docs
22 changes: 20 additions & 2 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
- 💅许多开箱即用的 [extension](https://github.com/Leecason/element-tiptap#extensions) (欢迎提交 issue 为新的 feature 留下建议👏)
- 🔖支持 markdown 语法
- 📘TypeScript 支持
- 🌐支持 i18n(`en`, `zh`, `pl`, `ru`, `de`). 欢迎贡献更多的语言
- 🌐支持 i18n(`en`, `zh`, `pl`, `ru`, `de`, `ko`). 欢迎贡献更多的语言
- 🎈可用的 `events`: `init`, `transaction`, `focus`, `blur`, `paste`, `drop`, `update`
- 🍀高度自定义, 你可以自定义 extension 和它对应的菜单按钮视图
- 💻也可以通过直接控制编辑器的行为来定制编辑器。
Expand Down Expand Up @@ -118,6 +118,7 @@ Vue.use(ElementTiptapPlugin, {
- `pl` by @FurtakM
- `ru` by @baitkul
- `de` by @Thesicstar
- `ko` by @Hotbrains

欢迎贡献更多的语言.

Expand Down Expand Up @@ -401,6 +402,22 @@ width: 700px;
height: 100%;
```

### showMenubar

类型: `boolean`

默认值: `true`

是否显示 menubar

### charCounterCount

类型: `boolean`

默认值: `true`

是否显示字数统计

## 👽 事件 Events

### Init
Expand Down Expand Up @@ -512,7 +529,7 @@ _OR_
- [x] `Table` extension
- [x] `Iframe` extension
- [x] `FontType` extension
- [ ] `FontSize` extension
- [x] `FontSize` extension
- [x] `TextColor` extension
- [x] `TextHighlight` extension
- [ ] `Emoji` extension
Expand All @@ -524,3 +541,4 @@ _OR_
- [x] 编辑器 readonly
- [x] 改变图片尺寸
- [ ] 主题
- [ ] 更详细的文档

0 comments on commit 57f0b8c

Please sign in to comment.