mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-30 02:19:52 +02:00
update readme
This commit is contained in:
@@ -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 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
|
||||
|
||||
- [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.
|
||||
- Designed to allow for collaborative editing to be layered on top.
|
||||
|
||||
|
||||
## 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
|
||||
- Plain Text
|
||||
- Auto-markdown
|
||||
- Links
|
||||
- Tables
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
Reference in New Issue
Block a user