mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-29 01:50:06 +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:
@@ -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.
|
||||
|
||||
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)
|
||||
- [Static Methods](#methods)
|
||||
|
@@ -1,8 +1,6 @@
|
||||
|
||||
# Links Example
|
||||
# Focus/Blur Example
|
||||
|
||||

|
||||
|
||||
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!
|
||||
This example shows you how you can focus or blur the editor, programmatically, and either immediately or after a short delay.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
||||
|
@@ -1,8 +1,6 @@
|
||||
|
||||
# Plain Text Example
|
||||
# Plugins Example
|
||||
|
||||

|
||||
|
||||
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.
|
||||
This example shows how you can extend Slate with plugins! The example shows plugins that perform simple operations on keypress.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
||||
|
@@ -1,8 +1,8 @@
|
||||
|
||||
# Plain Text Example
|
||||
# Right-to-Left Example
|
||||
|
||||

|
||||
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!
|
||||
|
6
examples/tables/Readme.md
Normal file
6
examples/tables/Readme.md
Normal 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!
|
Reference in New Issue
Block a user