From a51180cfb78a1e5678f80a92a1de6b4872e93903 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:10:55 -0800 Subject: [PATCH 1/8] add plugins doc --- docs/Readme.md | 1 + docs/general/plugins.md | 67 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 docs/general/plugins.md diff --git a/docs/Readme.md b/docs/Readme.md index 453f77763..ababa43bf 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -24,6 +24,7 @@ ## General +- [Plugins](./general/plugins.md) - [Resources](./general/resources.md) - [Contributing](../Contributing.md) - [Changelog](../Changelog.md) diff --git a/docs/general/plugins.md b/docs/general/plugins.md new file mode 100644 index 000000000..5b95e8b63 --- /dev/null +++ b/docs/general/plugins.md @@ -0,0 +1,67 @@ + +# Plugins + +Here's a list of Slate plugins, organized by category, so that they're easier to find than searching NPM or Yarn. + + +### Behavior + +Plugins that add specific behaviors to your editor. + +|**Plugin**|**Downloads**|**Description**| +|---|---|---| +|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|![](https://img.shields.io/npm/dt/slate-auto-replace.svg?maxAge=2592000)|Automatically transform certain input as a user types.| +|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|![](https://img.shields.io/npm/dt/slate-collapse-on-escape.svg?maxAge=2592000)|Collapse the selection when users hit esc.| +|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|![](https://img.shields.io/npm/dt/slate-drop-or-paste-images.svg?maxAge=2592000)|Allows users to insert images by drag-dropping or copy-pasting.| +|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|![](https://img.shields.io/npm/dt/slate-edit-blockquote.svg?maxAge=2592000)|Adds blockquote editing behaviors to an editor.| +|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|![](https://img.shields.io/npm/dt/slate-edit-code.svg?maxAge=2592000)|Adds code block editing behaviors to an editor.| +|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|![](https://img.shields.io/npm/dt/slate-edit-footnote.svg?maxAge=2592000)|Adds footnote editing behaviors to an editor.| +|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|![](https://img.shields.io/npm/dt/slate-edit-list.svg?maxAge=2592000)|Adds list editing behaviors to an editor.| +|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|![](https://img.shields.io/npm/dt/slate-edit-table.svg?maxAge=2592000)|Adds common table editing behaviors to an editor.| +|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|![](https://img.shields.io/npm/dt/slate-mentions.svg?maxAge=2592000)|Adds mentions like Facebook's to an editor.| +|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|![](https://img.shields.io/npm/dt/slate-no-empty.svg?maxAge=2592000)|Prevents documents from being empty.| +|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|![](https://img.shields.io/npm/dt/slate-paste-linkify.svg?maxAge=2592000)|Automatically linkify URLs when they are pasted.| +|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|![](https://img.shields.io/npm/dt/slate-soft-break.svg?maxAge=2592000)|Adds soft breaks when users hit enter.| +|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|![](https://img.shields.io/npm/dt/slate-sticky-inlines.svg?maxAge=2592000)|Changes the inline node behavior to allow editing at the edges.| +|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|![](https://img.shields.io/npm/dt/slate-suggestions.svg?maxAge=2592000)|Displays inline auto-completed suggestions.| +|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|![](https://img.shields.io/npm/dt/slate-trailing-block.svg?maxAge=2592000)|Ensure that documents end in a specific kind of block.| + + +### Components + +Components for building Slate editors. + +|**Plugin**|**Downloads**|**Description**| +|---|---|---| +|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|![](https://img.shields.io/npm/dt/slate-editor-icons.svg?maxAge=2592000)|A set of icons for using in toolbars, etc.| + + +### Serializers + +Serializers for handling Slate data. + +|**Plugin**|**Downloads**|**Description**| +|---|---|---| +|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|![](https://img.shields.io/npm/dt/slate-base64-serializer.svg?maxAge=2592000)|A base64 string serializer for Slate documents.| +|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|![](https://img.shields.io/npm/dt/slate-html-serializer.svg?maxAge=2592000)|An HTML serializer for Slate documents.| +|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|![](https://img.shields.io/npm/dt/slate-plain-serializer.svg?maxAge=2592000)|A plain text serializer for Slate documents.| + + +### Utils + +Useful utilities when working with Slate documents and components. + +|**Plugin**|**Downloads**|**Description**| +|---|---|---| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dt/slate-hyperprint.svg?maxAge=2592000)|Prints Slate documents in their `slate-hyperscript` format.| +|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|![](https://img.shields.io/npm/dt/slate-hyperscript.svg?maxAge=2592000)|Allows you to express Slate documents in JSX.| +|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|![](https://img.shields.io/npm/dt/slate-prop-types.svg?maxAge=2592000)|A set of prop types to use in your Slate components.| + + +### Editors + +Full-feature editors for Slate, in case you need a drop-in one. + +|**Plugin**|**Downloads**|**Description**| +|---|---|---| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dt/slate-hyperprint.svg?maxAge=2592000)|Prints Slate documents in their `slate-hyperscript` format.| From 17a1c49cea7bb37ae414a286a5683ae851db903c Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:15:45 -0800 Subject: [PATCH 2/8] update plugins doc --- docs/general/plugins.md | 46 ++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/general/plugins.md b/docs/general/plugins.md index 5b95e8b63..44dc501e7 100644 --- a/docs/general/plugins.md +++ b/docs/general/plugins.md @@ -10,21 +10,21 @@ Plugins that add specific behaviors to your editor. |**Plugin**|**Downloads**|**Description**| |---|---|---| -|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|![](https://img.shields.io/npm/dt/slate-auto-replace.svg?maxAge=2592000)|Automatically transform certain input as a user types.| -|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|![](https://img.shields.io/npm/dt/slate-collapse-on-escape.svg?maxAge=2592000)|Collapse the selection when users hit esc.| -|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|![](https://img.shields.io/npm/dt/slate-drop-or-paste-images.svg?maxAge=2592000)|Allows users to insert images by drag-dropping or copy-pasting.| -|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|![](https://img.shields.io/npm/dt/slate-edit-blockquote.svg?maxAge=2592000)|Adds blockquote editing behaviors to an editor.| -|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|![](https://img.shields.io/npm/dt/slate-edit-code.svg?maxAge=2592000)|Adds code block editing behaviors to an editor.| -|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|![](https://img.shields.io/npm/dt/slate-edit-footnote.svg?maxAge=2592000)|Adds footnote editing behaviors to an editor.| -|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|![](https://img.shields.io/npm/dt/slate-edit-list.svg?maxAge=2592000)|Adds list editing behaviors to an editor.| -|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|![](https://img.shields.io/npm/dt/slate-edit-table.svg?maxAge=2592000)|Adds common table editing behaviors to an editor.| -|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|![](https://img.shields.io/npm/dt/slate-mentions.svg?maxAge=2592000)|Adds mentions like Facebook's to an editor.| -|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|![](https://img.shields.io/npm/dt/slate-no-empty.svg?maxAge=2592000)|Prevents documents from being empty.| -|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|![](https://img.shields.io/npm/dt/slate-paste-linkify.svg?maxAge=2592000)|Automatically linkify URLs when they are pasted.| -|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|![](https://img.shields.io/npm/dt/slate-soft-break.svg?maxAge=2592000)|Adds soft breaks when users hit enter.| -|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|![](https://img.shields.io/npm/dt/slate-sticky-inlines.svg?maxAge=2592000)|Changes the inline node behavior to allow editing at the edges.| -|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|![](https://img.shields.io/npm/dt/slate-suggestions.svg?maxAge=2592000)|Displays inline auto-completed suggestions.| -|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|![](https://img.shields.io/npm/dt/slate-trailing-block.svg?maxAge=2592000)|Ensure that documents end in a specific kind of block.| +|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|![](https://img.shields.io/npm/dm/slate-auto-replace.svg?maxAge=3600&label=⬇)|Automatically transform certain input as a user types.| +|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|![](https://img.shields.io/npm/dm/slate-collapse-on-escape.svg?maxAge=3600&label=⬇)|Collapse the selection when users hit esc.| +|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|![](https://img.shields.io/npm/dm/slate-drop-or-paste-images.svg?maxAge=3600&label=⬇)|Allows users to insert images by drag-dropping or copy-pasting.| +|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|![](https://img.shields.io/npm/dm/slate-edit-blockquote.svg?maxAge=3600&label=⬇)|Adds blockquote editing behaviors to an editor.| +|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|![](https://img.shields.io/npm/dm/slate-edit-code.svg?maxAge=3600&label=⬇)|Adds code block editing behaviors to an editor.| +|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|![](https://img.shields.io/npm/dm/slate-edit-footnote.svg?maxAge=3600&label=⬇)|Adds footnote editing behaviors to an editor.| +|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|![](https://img.shields.io/npm/dm/slate-edit-list.svg?maxAge=3600&label=⬇)|Adds list editing behaviors to an editor.| +|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|![](https://img.shields.io/npm/dm/slate-edit-table.svg?maxAge=3600&label=⬇)|Adds common table editing behaviors to an editor.| +|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|![](https://img.shields.io/npm/dm/slate-mentions.svg?maxAge=3600&label=⬇)|Adds mentions like Facebook's to an editor.| +|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|![](https://img.shields.io/npm/dm/slate-no-empty.svg?maxAge=3600&label=⬇)|Prevents documents from being empty.| +|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|![](https://img.shields.io/npm/dm/slate-paste-linkify.svg?maxAge=3600&label=⬇)|Automatically linkify URLs when they are pasted.| +|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|![](https://img.shields.io/npm/dm/slate-soft-break.svg?maxAge=3600&label=⬇)|Adds soft breaks when users hit enter.| +|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|![](https://img.shields.io/npm/dm/slate-sticky-inlines.svg?maxAge=3600&label=⬇)|Changes the inline node behavior to allow editing at the edges.| +|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|![](https://img.shields.io/npm/dm/slate-suggestions.svg?maxAge=3600&label=⬇)|Displays inline auto-completed suggestions.| +|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|![](https://img.shields.io/npm/dm/slate-trailing-block.svg?maxAge=3600&label=⬇)|Ensure that documents end in a specific kind of block.| ### Components @@ -33,7 +33,7 @@ Components for building Slate editors. |**Plugin**|**Downloads**|**Description**| |---|---|---| -|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|![](https://img.shields.io/npm/dt/slate-editor-icons.svg?maxAge=2592000)|A set of icons for using in toolbars, etc.| +|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|![](https://img.shields.io/npm/dm/slate-editor-icons.svg?maxAge=3600&label=⬇)|A set of icons for using in toolbars, etc.| ### Serializers @@ -42,9 +42,9 @@ Serializers for handling Slate data. |**Plugin**|**Downloads**|**Description**| |---|---|---| -|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|![](https://img.shields.io/npm/dt/slate-base64-serializer.svg?maxAge=2592000)|A base64 string serializer for Slate documents.| -|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|![](https://img.shields.io/npm/dt/slate-html-serializer.svg?maxAge=2592000)|An HTML serializer for Slate documents.| -|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|![](https://img.shields.io/npm/dt/slate-plain-serializer.svg?maxAge=2592000)|A plain text serializer for Slate documents.| +|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|![](https://img.shields.io/npm/dm/slate-base64-serializer.svg?maxAge=3600&label=⬇)|A base64 string serializer for Slate documents.| +|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|![](https://img.shields.io/npm/dm/slate-html-serializer.svg?maxAge=3600&label=⬇)|An HTML serializer for Slate documents.| +|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|![](https://img.shields.io/npm/dm/slate-plain-serializer.svg?maxAge=3600&label=⬇)|A plain text serializer for Slate documents.| ### Utils @@ -53,9 +53,9 @@ Useful utilities when working with Slate documents and components. |**Plugin**|**Downloads**|**Description**| |---|---|---| -|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dt/slate-hyperprint.svg?maxAge=2592000)|Prints Slate documents in their `slate-hyperscript` format.| -|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|![](https://img.shields.io/npm/dt/slate-hyperscript.svg?maxAge=2592000)|Allows you to express Slate documents in JSX.| -|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|![](https://img.shields.io/npm/dt/slate-prop-types.svg?maxAge=2592000)|A set of prop types to use in your Slate components.| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)|Prints Slate documents in their `slate-hyperscript` format.| +|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|![](https://img.shields.io/npm/dm/slate-hyperscript.svg?maxAge=3600&label=⬇)|Allows you to express Slate documents in JSX.| +|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|![](https://img.shields.io/npm/dm/slate-prop-types.svg?maxAge=3600&label=⬇)|A set of prop types to use in your Slate components.| ### Editors @@ -64,4 +64,4 @@ Full-feature editors for Slate, in case you need a drop-in one. |**Plugin**|**Downloads**|**Description**| |---|---|---| -|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dt/slate-hyperprint.svg?maxAge=2592000)|Prints Slate documents in their `slate-hyperscript` format.| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)|Prints Slate documents in their `slate-hyperscript` format.| From a5c0f668cafeeb6bb06a421b5e7aac48edf14971 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:19:05 -0800 Subject: [PATCH 3/8] update plugins doc --- docs/general/plugins.md | 56 ++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/general/plugins.md b/docs/general/plugins.md index 44dc501e7..88f2bce3c 100644 --- a/docs/general/plugins.md +++ b/docs/general/plugins.md @@ -8,60 +8,60 @@ Here's a list of Slate plugins, organized by category, so that they're easier to Plugins that add specific behaviors to your editor. -|**Plugin**|**Downloads**|**Description**| +|**Plugin**|**Description**|**Downloads**| |---|---|---| -|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|![](https://img.shields.io/npm/dm/slate-auto-replace.svg?maxAge=3600&label=⬇)|Automatically transform certain input as a user types.| -|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|![](https://img.shields.io/npm/dm/slate-collapse-on-escape.svg?maxAge=3600&label=⬇)|Collapse the selection when users hit esc.| -|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|![](https://img.shields.io/npm/dm/slate-drop-or-paste-images.svg?maxAge=3600&label=⬇)|Allows users to insert images by drag-dropping or copy-pasting.| -|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|![](https://img.shields.io/npm/dm/slate-edit-blockquote.svg?maxAge=3600&label=⬇)|Adds blockquote editing behaviors to an editor.| -|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|![](https://img.shields.io/npm/dm/slate-edit-code.svg?maxAge=3600&label=⬇)|Adds code block editing behaviors to an editor.| -|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|![](https://img.shields.io/npm/dm/slate-edit-footnote.svg?maxAge=3600&label=⬇)|Adds footnote editing behaviors to an editor.| -|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|![](https://img.shields.io/npm/dm/slate-edit-list.svg?maxAge=3600&label=⬇)|Adds list editing behaviors to an editor.| -|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|![](https://img.shields.io/npm/dm/slate-edit-table.svg?maxAge=3600&label=⬇)|Adds common table editing behaviors to an editor.| -|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|![](https://img.shields.io/npm/dm/slate-mentions.svg?maxAge=3600&label=⬇)|Adds mentions like Facebook's to an editor.| -|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|![](https://img.shields.io/npm/dm/slate-no-empty.svg?maxAge=3600&label=⬇)|Prevents documents from being empty.| -|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|![](https://img.shields.io/npm/dm/slate-paste-linkify.svg?maxAge=3600&label=⬇)|Automatically linkify URLs when they are pasted.| -|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|![](https://img.shields.io/npm/dm/slate-soft-break.svg?maxAge=3600&label=⬇)|Adds soft breaks when users hit enter.| -|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|![](https://img.shields.io/npm/dm/slate-sticky-inlines.svg?maxAge=3600&label=⬇)|Changes the inline node behavior to allow editing at the edges.| -|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|![](https://img.shields.io/npm/dm/slate-suggestions.svg?maxAge=3600&label=⬇)|Displays inline auto-completed suggestions.| -|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|![](https://img.shields.io/npm/dm/slate-trailing-block.svg?maxAge=3600&label=⬇)|Ensure that documents end in a specific kind of block.| +|[`slate-auto-replace`](https://yarnpkg.com/en/package/slate-auto-replace)|Automatically transform certain input as a user types.|![](https://img.shields.io/npm/dm/slate-auto-replace.svg?maxAge=3600&label=⬇)| +|[`slate-collapse-on-escape`](https://yarnpkg.com/en/package/slate-collapse-on-escape)|Collapse the selection when users hit esc.|![](https://img.shields.io/npm/dm/slate-collapse-on-escape.svg?maxAge=3600&label=⬇)| +|[`slate-drop-or-paste-images`](https://yarnpkg.com/en/package/slate-drop-or-paste-images)|Allows users to insert images by drag-dropping or copy-pasting.|![](https://img.shields.io/npm/dm/slate-drop-or-paste-images.svg?maxAge=3600&label=⬇)| +|[`slate-edit-blockquote`](https://yarnpkg.com/en/package/slate-edit-blockquote)|Adds blockquote editing behaviors to an editor.|![](https://img.shields.io/npm/dm/slate-edit-blockquote.svg?maxAge=3600&label=⬇)| +|[`slate-edit-code`](https://yarnpkg.com/en/package/slate-edit-code)|Adds code block editing behaviors to an editor.|![](https://img.shields.io/npm/dm/slate-edit-code.svg?maxAge=3600&label=⬇)| +|[`slate-edit-footnote`](https://yarnpkg.com/en/package/slate-edit-footnote)|Adds footnote editing behaviors to an editor.|![](https://img.shields.io/npm/dm/slate-edit-footnote.svg?maxAge=3600&label=⬇)| +|[`slate-edit-list`](https://yarnpkg.com/en/package/slate-edit-list)|Adds list editing behaviors to an editor.|![](https://img.shields.io/npm/dm/slate-edit-list.svg?maxAge=3600&label=⬇)| +|[`slate-edit-table`](https://yarnpkg.com/en/package/slate-edit-table)|Adds common table editing behaviors to an editor.|![](https://img.shields.io/npm/dm/slate-edit-table.svg?maxAge=3600&label=⬇)| +|[`slate-mentions`](https://yarnpkg.com/en/package/slate-mentions)|Adds mentions like Facebook's to an editor.|![](https://img.shields.io/npm/dm/slate-mentions.svg?maxAge=3600&label=⬇)| +|[`slate-no-empty`](https://yarnpkg.com/en/package/slate-no-empty)|Prevents documents from being empty.|![](https://img.shields.io/npm/dm/slate-no-empty.svg?maxAge=3600&label=⬇)| +|[`slate-paste-linkify`](https://yarnpkg.com/en/package/slate-paste-linkify)|Automatically linkify URLs when they are pasted.|![](https://img.shields.io/npm/dm/slate-paste-linkify.svg?maxAge=3600&label=⬇)| +|[`slate-soft-break`](https://yarnpkg.com/en/package/slate-soft-break)|Adds soft breaks when users hit enter.|![](https://img.shields.io/npm/dm/slate-soft-break.svg?maxAge=3600&label=⬇)| +|[`slate-sticky-inlines`](https://yarnpkg.com/en/package/slate-sticky-inlines)|Changes the inline node behavior to allow editing at the edges.|![](https://img.shields.io/npm/dm/slate-sticky-inlines.svg?maxAge=3600&label=⬇)| +|[`slate-suggestions`](https://yarnpkg.com/en/package/slate-suggestions)|Displays inline auto-completed suggestions.|![](https://img.shields.io/npm/dm/slate-suggestions.svg?maxAge=3600&label=⬇)| +|[`slate-trailing-block`](https://yarnpkg.com/en/package/slate-trailing-block)|Ensure that documents end in a specific kind of block.|![](https://img.shields.io/npm/dm/slate-trailing-block.svg?maxAge=3600&label=⬇)| ### Components Components for building Slate editors. -|**Plugin**|**Downloads**|**Description**| +|**Plugin**|**Description**|**Downloads**| |---|---|---| -|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|![](https://img.shields.io/npm/dm/slate-editor-icons.svg?maxAge=3600&label=⬇)|A set of icons for using in toolbars, etc.| +|[`slate-editor-icons`](https://yarnpkg.com/en/package/slate-editor-icons)|A set of icons for using in toolbars, etc.|![](https://img.shields.io/npm/dm/slate-editor-icons.svg?maxAge=3600&label=⬇)| ### Serializers Serializers for handling Slate data. -|**Plugin**|**Downloads**|**Description**| +|**Plugin**|**Description**|**Downloads**| |---|---|---| -|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|![](https://img.shields.io/npm/dm/slate-base64-serializer.svg?maxAge=3600&label=⬇)|A base64 string serializer for Slate documents.| -|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|![](https://img.shields.io/npm/dm/slate-html-serializer.svg?maxAge=3600&label=⬇)|An HTML serializer for Slate documents.| -|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|![](https://img.shields.io/npm/dm/slate-plain-serializer.svg?maxAge=3600&label=⬇)|A plain text serializer for Slate documents.| +|[`slate-base64-serializer`](https://yarnpkg.com/en/package/slate-base64-serializer)|A base64 string serializer for Slate documents.|![](https://img.shields.io/npm/dm/slate-base64-serializer.svg?maxAge=3600&label=⬇)| +|[`slate-html-serializer`](https://yarnpkg.com/en/package/slate-html-serializer)|An HTML serializer for Slate documents.|![](https://img.shields.io/npm/dm/slate-html-serializer.svg?maxAge=3600&label=⬇)| +|[`slate-plain-serializer`](https://yarnpkg.com/en/package/slate-plain-serializer)|A plain text serializer for Slate documents.|![](https://img.shields.io/npm/dm/slate-plain-serializer.svg?maxAge=3600&label=⬇)| ### Utils Useful utilities when working with Slate documents and components. -|**Plugin**|**Downloads**|**Description**| +|**Plugin**|**Description**|**Downloads**| |---|---|---| -|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)|Prints Slate documents in their `slate-hyperscript` format.| -|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|![](https://img.shields.io/npm/dm/slate-hyperscript.svg?maxAge=3600&label=⬇)|Allows you to express Slate documents in JSX.| -|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|![](https://img.shields.io/npm/dm/slate-prop-types.svg?maxAge=3600&label=⬇)|A set of prop types to use in your Slate components.| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)| +|[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|Allows you to express Slate documents in JSX.|![](https://img.shields.io/npm/dm/slate-hyperscript.svg?maxAge=3600&label=⬇)| +|[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|A set of prop types to use in your Slate components.|![](https://img.shields.io/npm/dm/slate-prop-types.svg?maxAge=3600&label=⬇)| ### Editors Full-feature editors for Slate, in case you need a drop-in one. -|**Plugin**|**Downloads**|**Description**| +|**Plugin**|**Description**|**Downloads**| |---|---|---| -|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)|Prints Slate documents in their `slate-hyperscript` format.| +|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)| From 9f358d1d29ed59908d49afb43c7460aa7619b4ef Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:21:10 -0800 Subject: [PATCH 4/8] update plugins reference links --- Readme.md | 2 +- docs/Introduction.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 7a5e3b578..107bad3bd 100644 --- a/Readme.md +++ b/Readme.md @@ -153,7 +153,7 @@ Slate encourages you to write small, reusable modules. Check out the public ones - [`slate-prism`](https://github.com/GitbookIO/slate-prism) highlights code blocks with [Prism.js](http://prismjs.com/)! - [`slate-soft-break`](https://github.com/ianstormtaylor/slate-soft-break) adds a soft break when `enter` is pressed. - [`slate-drop-or-paste-images`](https://github.com/ianstormtaylor/slate-drop-or-paste-images) lets users drop or paste images to insert them! -- [**See all the plugins...**](https://yarnpkg.com/en/packages?q=slate) +- [**See all the plugins...**](https://github.com/ianstormtaylor/slate/blob/master/docs/general/plugins.md)
diff --git a/docs/Introduction.md b/docs/Introduction.md index 44b36ea1e..92e20d05a 100644 --- a/docs/Introduction.md +++ b/docs/Introduction.md @@ -93,7 +93,7 @@ Slate encourages you to write small, reusable modules. Check out the public ones - [`slate-prism`](https://github.com/GitbookIO/slate-prism) highlights code blocks with [Prism.js](http://prismjs.com/)! - [`slate-soft-break`](https://github.com/ianstormtaylor/slate-soft-break) adds a soft break when `enter` is pressed. - [`slate-drop-or-paste-images`](https://github.com/ianstormtaylor/slate-drop-or-paste-images) lets users drop or paste images to insert them! -- [**View all plugins on `npm`...**](https://www.npmjs.com/browse/keyword/slate) +- [**View all plugins...**](https://github.com/ianstormtaylor/slate/blob/master/docs/general/plugins.md) ## Documentation From c9f98525b2b3b7ee9bc9cd35166198176846226e Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:22:52 -0800 Subject: [PATCH 5/8] remove editors section from plugins docs --- docs/general/plugins.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/docs/general/plugins.md b/docs/general/plugins.md index 88f2bce3c..1db91fca7 100644 --- a/docs/general/plugins.md +++ b/docs/general/plugins.md @@ -56,12 +56,3 @@ Useful utilities when working with Slate documents and components. |[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)| |[`slate-hyperscript`](https://yarnpkg.com/en/package/slate-hyperscript)|Allows you to express Slate documents in JSX.|![](https://img.shields.io/npm/dm/slate-hyperscript.svg?maxAge=3600&label=⬇)| |[`slate-prop-types`](https://yarnpkg.com/en/package/slate-prop-types)|A set of prop types to use in your Slate components.|![](https://img.shields.io/npm/dm/slate-prop-types.svg?maxAge=3600&label=⬇)| - - -### Editors - -Full-feature editors for Slate, in case you need a drop-in one. - -|**Plugin**|**Description**|**Downloads**| -|---|---|---| -|[`slate-hyperprint`](https://yarnpkg.com/en/package/slate-hyperprint)|Prints Slate documents in their `slate-hyperscript` format.|![](https://img.shields.io/npm/dm/slate-hyperprint.svg?maxAge=3600&label=⬇)| From b991d71abf4b61f165807eaa47735cafd7f1100e Mon Sep 17 00:00:00 2001 From: Ryan Grove Date: Wed, 10 Jan 2018 22:26:42 -0800 Subject: [PATCH 6/8] Fix double-handling of iOS return and backspace keypresses (#1520) Fixes #1519 --- packages/slate-react/src/plugins/after.js | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/slate-react/src/plugins/after.js b/packages/slate-react/src/plugins/after.js index fc8d9a8e7..0e93670ce 100644 --- a/packages/slate-react/src/plugins/after.js +++ b/packages/slate-react/src/plugins/after.js @@ -6,6 +6,7 @@ import React from 'react' import getWindow from 'get-window' import { Block, Inline, Text } from 'slate' +import { IS_IOS } from '../constants/environment' import EVENT_HANDLERS from '../constants/event-handlers' import HOTKEYS from '../constants/hotkeys' import Content from '../components/content' @@ -362,17 +363,20 @@ function AfterPlugin() { const { value } = change - if (HOTKEYS.SPLIT_BLOCK(event)) { + // COMPAT: In iOS, some of these hotkeys are handled in the + // `onNativeBeforeInput` handler of the `` component in order to + // preserve native autocorrect behavior, so they shouldn't be handled here. + if (HOTKEYS.SPLIT_BLOCK(event) && !IS_IOS) { return value.isInVoid ? change.collapseToStartOfNextText() : change.splitBlock() } - if (HOTKEYS.DELETE_CHAR_BACKWARD(event)) { + if (HOTKEYS.DELETE_CHAR_BACKWARD(event) && !IS_IOS) { return change.deleteCharBackward() } - if (HOTKEYS.DELETE_CHAR_FORWARD(event)) { + if (HOTKEYS.DELETE_CHAR_FORWARD(event) && !IS_IOS) { return change.deleteCharForward() } From 9e2c42297c6b38527bdafe37c91cab6008a1d004 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:28:12 -0800 Subject: [PATCH 7/8] update plugins link in readme --- Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 107bad3bd..2258ffb68 100644 --- a/Readme.md +++ b/Readme.md @@ -14,7 +14,7 @@ Principles · Demo · Examples · - Plugins · + Plugins · Documentation · Contributing!

@@ -153,7 +153,7 @@ Slate encourages you to write small, reusable modules. Check out the public ones - [`slate-prism`](https://github.com/GitbookIO/slate-prism) highlights code blocks with [Prism.js](http://prismjs.com/)! - [`slate-soft-break`](https://github.com/ianstormtaylor/slate-soft-break) adds a soft break when `enter` is pressed. - [`slate-drop-or-paste-images`](https://github.com/ianstormtaylor/slate-drop-or-paste-images) lets users drop or paste images to insert them! -- [**See all the plugins...**](https://github.com/ianstormtaylor/slate/blob/master/docs/general/plugins.md) +- [**See all the plugins...**](./docs/general/plugins.md)
From db0fd84bbc30b7f700a68f7eb19499bd67b67033 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Wed, 10 Jan 2018 22:30:29 -0800 Subject: [PATCH 8/8] update cache time for readme badge images --- Readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 2258ffb68..57a8b59b2 100644 --- a/Readme.md +++ b/Readme.md @@ -26,7 +26,7 @@

- + @@ -41,13 +41,13 @@ - + - + - +