mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-07-31 04:20:26 +02:00
add more example readmes
This commit is contained in:
@@ -3,6 +3,6 @@
|
||||
|
||||

|
||||
|
||||
This example shows you add a few key command handlers to get Markdown-like shortcuts in the editor. Such that once you press `> ` at the start of a line it turns it into a block quote!
|
||||
This example shows you can add a few key command handlers to get Markdown-like shortcuts in the editor. Such that once you press `> ` at the start of a line it turns it into a block quote!
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
||||
|
8
examples/code-highlighting/Readme.md
Normal file
8
examples/code-highlighting/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Code Highlighting Example
|
||||
|
||||

|
||||
|
||||
This example shows you how to use "decorators" to render dynamically formatted text—in this case, code blocks!
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
8
examples/hovering-menu/Readme.md
Normal file
8
examples/hovering-menu/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Hovering Menu Example
|
||||
|
||||

|
||||
|
||||
This example shows you add a menu that appears hovering above the current selection as a user clicks around, where you can add formatting buttons. The menu is its own React component, completely separate from Slate, but the buttons in it are wired up to change the content in Slate's editor.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
9
examples/images/Readme.md
Normal file
9
examples/images/Readme.md
Normal file
@@ -0,0 +1,9 @@
|
||||
|
||||
# Images Example
|
||||
|
||||

|
||||
|
||||
This example shows you how you can use "void" nodes to render content that has no text in it, like images.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
||||
|
8
examples/links/Readme.md
Normal file
8
examples/links/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Links 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!
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
8
examples/paste-html/Readme.md
Normal file
8
examples/paste-html/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Paste HTML Example
|
||||
|
||||

|
||||
|
||||
This example shows you how you can use the HTML serializer to convert HTML that a user pastes into the editor into formatted text, instead of it defaulting to plain text.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
8
examples/plain-text/Readme.md
Normal file
8
examples/plain-text/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Plain Text 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.
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
8
examples/rich-text/Readme.md
Normal file
8
examples/rich-text/Readme.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
# Rich Text Example
|
||||
|
||||

|
||||
|
||||
This example shows you can add a very different concepts together: key commands, toolbars, and custom formatting, to get the functionality you'd expect from a rich text editor. Of course this is just the beginning, you can layer in whatever other behaviors you want!
|
||||
|
||||
Check out the [Examples readme](..) to see how to run it!
|
Reference in New Issue
Block a user