mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-07-31 04:20:26 +02:00
Code Issues Releases Wiki Activity

remove hard to maintain examples readmes

Browse Source
This commit is contained in:
Ian Storm Taylor
2017-10-28 16:24:03 -07:00
parent 03528d828b
commit 3b497bc342
20 changed files with 0 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
examples/check-lists/Readme.md
View File

@@ -1,8 +0,0 @@
# Rich Text Example
![](../../docs/images/rich-text-example.png)
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!

8
examples/code-highlighting/Readme.md
View File

@@ -1,8 +0,0 @@
# Code Highlighting Example
![](../../docs/images/code-highlighting-example.png)
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!

9
examples/embeds/Readme.md
View File

@@ -1,9 +0,0 @@
# Images Example
![](../../docs/images/images-example.png)
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/emojis/Readme.md
View File

@@ -1,8 +0,0 @@
# Emojis Example
![](../../docs/images/links-example.png)
This example shows you how you can insert inline void nodes. This is how you'd add emojis or inline images to Slate.
Check out the [Examples readme](..) to see how to run it!

8
examples/forced-layout/Readme.md
View File

@@ -1,8 +0,0 @@
# Forced Layout Example
![](../../docs/images/forced-layout-example.png)
This example shows you how you can use Rules in your schema to enforce a document structure. The basic example enforces having one title block that is always at the top, and at least one paragraph block underneath it.
Check out the [Examples readme](..) to see how to run it!

8
examples/hovering-menu/Readme.md
View File

@@ -1,8 +0,0 @@
# Hovering Menu Example
![](../../docs/images/hovering-menu-example.png)
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!

6
examples/huge-document/Readme.md
View File

@@ -1,6 +0,0 @@
# Large Text Example
This example showcase performance of Slate when editing a large document.
Check out the [Examples readme](..) to see how to run it!

9
examples/images/Readme.md
View File

@@ -1,9 +0,0 @@
# Images Example
![](../../docs/images/images-example.png)
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
View File

@@ -1,8 +0,0 @@
# Links Example
![](../../docs/images/links-example.png)
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/markdown-preview/Readme.md
View File

@@ -1,8 +0,0 @@
# Auto-markdown Example
![](../../docs/images/auto-markdown-example.png)
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/markdown-shortcuts/Readme.md
View File

@@ -1,8 +0,0 @@
# Auto-markdown Example
![](../../docs/images/auto-markdown-example.png)
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/paste-html/Readme.md
View File

@@ -1,8 +0,0 @@
# Paste HTML Example
![](../../docs/images/paste-html-example.png)
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
View File

@@ -1,8 +0,0 @@
# Plain Text Example
![](../../docs/images/plain-text-example.png)
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!

6
examples/plugins/Readme.md
View File

@@ -1,6 +0,0 @@
# Plugins Example
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!

8
examples/read-only/Readme.md
View File

@@ -1,8 +0,0 @@
# Read-only Example
![](../../docs/images/read-only-example.png)
This example shows how you can render Slate in "read-only" mode, where the user can still see the document exactly as it would normal be rendered, but they cannot edit the content in any way. This is useful for cases where the user has "see" persmissions but not "edit" permissions.
Check out the [Examples readme](..) to see how to run it!

8
examples/rich-text/Readme.md
View File

@@ -1,8 +0,0 @@
# Rich Text Example
![](../../docs/images/rich-text-example.png)
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!

8
examples/rtl/Readme.md
View File

@@ -1,8 +0,0 @@
# Right-to-Left Example
This example shows how Slate automatically detects and handles right-to-left text editing (like in Arabic, Hebrew, etc.).
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!

8
examples/search-highlighting/Readme.md
View File

@@ -1,8 +0,0 @@
# Rich Text Example
![](../../docs/images/rich-text-example.png)
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!

8
examples/syncing-operations/Readme.md
View File

@@ -1,8 +0,0 @@
# Rich Text Example
![](../../docs/images/rich-text-example.png)
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!

6
examples/tables/Readme.md
View File

@@ -1,6 +0,0 @@
# 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!