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=⬇)|