mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-31 10:51:44 +02:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Ian Storm Taylor
2016-06-28 09:27:00 -07:00
parent d2d846849f
commit b2f4750eed
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Readme.md
View File

@@ -4,6 +4,8 @@
Slate is a completely customizable framework for building rich text editors in the browser. You can think of it like a pluggable implementation of `contenteditable`, built with React and Immutable. Slate was inspired by [Draft.js](https://facebook.github.io/draft-js/) and [Prosemirror](http://prosemirror.net/). Slate is a completely customizable framework for building rich text editors in the browser. You can think of it like a pluggable implementation of `contenteditable`, built with React and Immutable. Slate was inspired by [Draft.js](https://facebook.github.io/draft-js/) and [Prosemirror](http://prosemirror.net/).
_Slate is currently in **beta**, while work is being done on: cross-browser support, atomic node support, and collaboration support. It's completely useable, but you might need to pull request one or two fixes for your use case._
###### Table of Contents ###### Table of Contents
- [Principles](#principles) - [Principles](#principles)
@@ -18,12 +20,16 @@ Slate is a completely customizable framework for building rich text editors in t
- Doesn't bake any opinions about the schema being edited into the core library. - Doesn't bake any opinions about the schema being edited into the core library.
- Designed to allow for collaborative editing to be layered on top. - Designed to allow for collaborative editing to be layered on top.
## Examples ## Examples
To get a sense for how Slate works, check out a few of the examples: To get a sense for how you might use Slate, check out a few of the examples:
- Rich Text - Rich Text
- Plain Text - Plain Text
- Auto-markdown - Auto-markdown
- Links - Links
- Tables - Tables
## Getting Started