1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-01-17 21:49:20 +01:00
slate/Readme.md

28 lines
970 B
Markdown
Raw Normal View History

2016-06-28 08:42:38 -07:00
2016-06-28 09:06:06 -07:00
![Slate](support/banner.png)
2016-06-28 08:42:38 -07:00
2016-06-28 08:54:24 -07:00
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 libraries like [Draft.js](https://facebook.github.io/draft-js/) and [Prosemirror](http://prosemirror.net/).
2016-06-28 08:51:15 -07:00
2016-06-28 08:54:24 -07:00
###### Table of Contents
2016-06-28 08:51:15 -07:00
- [Principles](#principles)
- [Examples](#examples)
2016-06-28 08:42:38 -07:00
## Principles
2016-06-28 08:53:35 -07:00
- Built with React and Immutable for performant stateless re-rendering and developing ease.
- Based on a nested, recursive tree model just like the DOM, so that complex components are possible.
- Made with plugins as a first-class consideration, so that almost all the logic is customizable.
- Doesn't bake any opinions about the schema being edited into the core library.
2016-06-28 08:42:38 -07:00
## Examples
To get a sense for how Slate works, check out a few of the examples:
- Rich Text
- Plain Text
- Auto-markdown
- Links
- Tables