1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-29 18:09:49 +02:00

Fixing Readme and API docs (#579)

* Fix typo

just a minor typo in the docs!

* Fix typo in API docs

* Update focus-blur example readme to reflect the correct example

* Remove extra newline

* Correct Readme on the plugins example as well

* Correct readme for RTL example

* Fix own typo.

* Adding a Readme for the tables example
This commit is contained in:
Anuj
2017-02-03 08:21:32 -08:00
committed by Ian Storm Taylor
parent e1b7a71583
commit 44cef94b04
5 changed files with 14 additions and 12 deletions

View File

@@ -9,7 +9,7 @@ The raw JSON serialized that ships by default with Slate. It converts a [`State`
In the raw format, text is represented as "ranges", which are a more compact way to represent the formatting applied to characters than the immutable model Slate uses internally. In the raw format, text is represented as "ranges", which are a more compact way to represent the formatting applied to characters than the immutable model Slate uses internally.
When saving the data to size-sensitive places, you the raw serializer can be told to omit properties that aren't _strictly_ required to deserialize later, reducing the serialized data's size. For example, if the dictionary of [`Data`](../models/data.md) for a [`Node`](../models/node.md) is empty, it will be omitted. When saving the data to size-sensitive places, the raw serializer can be told to omit properties that aren't _strictly_ required to deserialize later, reducing the serialized data's size. For example, if the dictionary of [`Data`](../models/data.md) for a [`Node`](../models/node.md) is empty, it will be omitted.
- [Example](#example) - [Example](#example)
- [Static Methods](#methods) - [Static Methods](#methods)

View File

@@ -1,8 +1,6 @@
# Links Example # Focus/Blur Example
![](../../docs/images/links-example.png) This example shows you how you can focus or blur the editor, programmatically, and either immediately or after a short delay.
This example shows you how you can wrap text in "inline" nodes to associate metadata, like an `href`, with a piece of text. This is how you'd add links to Slate, but it's also how you might add hashtags, at-mentions, and many more inline features!
Check out the [Examples readme](..) to see how to run it! Check out the [Examples readme](..) to see how to run it!

View File

@@ -1,8 +1,6 @@
# Plain Text Example # Plugins Example
![](../../docs/images/plain-text-example.png) This example shows how you can extend Slate with plugins! The example shows plugins that perform simple operations on keypress.
This is the most basic Slate example. It's basically a glorified `<textarea>`. But it gives you a sense for the absolute basics of Slate.
Check out the [Examples readme](..) to see how to run it! Check out the [Examples readme](..) to see how to run it!

View File

@@ -1,8 +1,8 @@
# Plain Text Example # Right-to-Left Example
![](../../docs/images/plain-text-example.png) This example shows how Slate automatically detects and handles right-to-left text editing (like in Arabic, Hebrew, etc.).
This is the most basic Slate example. It's basically a glorified `<textarea>`. But it gives you a sense for the absolute basics of Slate. Bonus: Features poetry from Khalil Gibran, from his book [The Prophet](https://en.wikipedia.org/wiki/The_Prophet_(book)).
Check out the [Examples readme](..) to see how to run it! Check out the [Examples readme](..) to see how to run it!

View File

@@ -0,0 +1,6 @@
# Tables Example
This example shows how the editor's recursive tree model can be used to create complex nested structures, like tables.
Check out the [Examples readme](..) to see how to run it!