mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-22 15:02:51 +02:00
Code Issues Releases Wiki Activity

update plugins doc

Browse Source
This commit is contained in:
Ian Storm Taylor
2018-01-10 22:15:45 -08:00
parent a51180cfb7
commit 17a1c49cea
1 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/general/plugins.md
View File

@@ -10,21 +10,21 @@ Plugins that add specific behaviors to your editor.
|**Plugin**|**Downloads**|**Description**| |**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-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/dt/slate-collapse-on-escape.svg?maxAge=2592000)|Collapse the selection when users hit <kbd>esc</kbd>.| |[`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 <kbd>esc</kbd>.|
|[`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-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/dt/slate-edit-blockquote.svg?maxAge=2592000)|Adds blockquote editing behaviors to an editor.| |[`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/dt/slate-edit-code.svg?maxAge=2592000)|Adds code block 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/dt/slate-edit-footnote.svg?maxAge=2592000)|Adds footnote 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/dt/slate-edit-list.svg?maxAge=2592000)|Adds list 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/dt/slate-edit-table.svg?maxAge=2592000)|Adds common table 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/dt/slate-mentions.svg?maxAge=2592000)|Adds mentions like Facebook's 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/dt/slate-no-empty.svg?maxAge=2592000)|Prevents documents from being empty.| |[`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/dt/slate-paste-linkify.svg?maxAge=2592000)|Automatically linkify URLs when they are pasted.| |[`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/dt/slate-soft-break.svg?maxAge=2592000)|Adds soft breaks when users hit <kbd>enter</kbd>.| |[`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 <kbd>enter</kbd>.|
|[`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-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/dt/slate-suggestions.svg?maxAge=2592000)|Displays inline auto-completed suggestions.| |[`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/dt/slate-trailing-block.svg?maxAge=2592000)|Ensure that documents end in a specific kind of block.| |[`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 ### Components
@@ -33,7 +33,7 @@ Components for building Slate editors.
|**Plugin**|**Downloads**|**Description**| |**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 ### Serializers
@@ -42,9 +42,9 @@ Serializers for handling Slate data.
|**Plugin**|**Downloads**|**Description**| |**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-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/dt/slate-html-serializer.svg?maxAge=2592000)|An HTML 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/dt/slate-plain-serializer.svg?maxAge=2592000)|A plain text 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 ### Utils
@@ -53,9 +53,9 @@ Useful utilities when working with Slate documents and components.
|**Plugin**|**Downloads**|**Description**| |**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.|
|[`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-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/dt/slate-prop-types.svg?maxAge=2592000)|A set of prop types to use in your Slate components.| |[`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 ### Editors
@@ -64,4 +64,4 @@ Full-feature editors for Slate, in case you need a drop-in one.
|**Plugin**|**Downloads**|**Description**| |**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.|