slate/docs/general/resources.md

# Resources

A few resources that are helpful for building with Slate.

## Libraries

These libraries are helpful when developing with Slate:

* [`is-hotkey`](https://github.com/ianstormtaylor/is-hotkey) is a simple way to check whether an `onKeyDown` handler should fire for a given hotkey, handling cross-platform concerns like <kbd>cmd</kbd> vs. <kbd>ctrl</kbd> keys for you automatically.
* [`react-broadcast`](https://github.com/ReactTraining/react-broadcast) works well when you need to have your custom node components re-render based on state that lives outside the `document`. It's the same pattern that `react-router` uses to update `<Link>` components.

## Tools

These tools are helpful when developing with Slate:

* [Immutable.js Console Extension](https://github.com/mattzeunert/immutable-object-formatter-extension) greatly improves the `console.log` output when working with [Immutable.js](https://immutable-js.github.io/immutable-js/) objects, which Slate's data model is based on.

## Products

These products use Slate, and can give you an idea of what's possible:

* [Cake](https://www.cake.co/)
* [Archbee](https://archbee.io)
* [Chatterbug](https://chatterbug.com)
* [GitBook](https://www.gitbook.com/)
* [Grafana](https://grafana.com/)
* [Guilded](https://www.guilded.gg)
* [Guru](https://www.getguru.com/)
* [Netlify CMS](https://www.netlifycms.org)
* [Outline](https://www.getoutline.com/)
* [Prezly](https://www.prezly.com/)
* [Sanity.io](https://www.sanity.io)
* [Taskade](https://www.taskade.com/)
* [Yuque](https://www.yuque.com/)
* [Thoughts](https://thoughts.teambition.com)

## Editors

These pre-packaged editors are built on top of Slate, and can be helpful to see how you might structure your code:

* [Canner Editor](https://github.com/Canner/canner-slate-editor) is a rich text editor.
* [French Press Editor](https://github.com/roast-cms/french-press-editor) is a customizeable editor with offline support.
* [Nossas Editor](http://slate-editor.bonde.org/) is a drop-in WYSIWYG editor.
* [ORY Editor](https://editor.ory.am/) is a self-contained, inline WYSIWYG editor library.
* [Outline Editor](https://github.com/outline/rich-markdown-editor) is the editor that powers the [Outline](https://www.getoutline.com/) wiki.
* [Chatterslate](https://github.com/chatterbugapp/chatterslate) helps teach language grammar and more at [Chatterbug](https://chatterbug.com).

(Or, if you have their exact use case, can be a drop-in editor for you.)
add resources to docs 2016-11-18 12:11:59 -08:00			`# Resources`

update docs 2017-09-06 09:35:08 -07:00			`A few resources that are helpful for building with Slate.`
add resources to docs 2016-11-18 12:11:59 -08:00
add react-broadcast to the docs 2017-10-15 15:29:30 -07:00			`## Libraries`

Update resources.md 2018-06-19 11:53:11 -07:00			`These libraries are helpful when developing with Slate:`

Lint JSON, CSS and Markdown files with Prettier (#1612) * Process and Lint CSS, Markdown and JSON files with Prettier * Run `yarn prettier` to re-format Markdown, CSS and JSON files 2018-02-07 15:58:41 +00:00			* [`is-hotkey`](https://github.com/ianstormtaylor/is-hotkey) is a simple way to check whether an `onKeyDown` handler should fire for a given hotkey, handling cross-platform concerns like <kbd>cmd</kbd> vs. <kbd>ctrl</kbd> keys for you automatically.
			* [`react-broadcast`](https://github.com/ReactTraining/react-broadcast) works well when you need to have your custom node components re-render based on state that lives outside the `document`. It's the same pattern that `react-router` uses to update `<Link>` components.
add react-broadcast to the docs 2017-10-15 15:29:30 -07:00
Remove deprecations (#2113) #### Is this adding or improving a _feature_ or fixing a _bug_? Debt. #### What's the new behavior? This removes almost all existing deprecations from previous API changes, to save on filesize and reduce complexity in the codebase going forward. It also changes from using the `slate-dev-logger` to using the Facebook-inspired `slate-dev-warning` which can be compiled out of production builds with [`babel-plugin-dev-expression`](https://github.com/4Catalyzer/babel-plugin-dev-expression) to save even further on file size. The only deprecations it keeps are in the `fromJSON` methods for data model changes like `.kind` and `.leaves` which may still may not have been migrated in databases, since this is a bigger pain point. #### Have you checked that...? * [x] The new code matches the existing patterns and styles. * [x] The tests pass with `yarn test`. * [x] The linter passes with `yarn lint`. (Fix errors with `yarn prettier`.) * [x] The relevant examples still work. (Run examples with `yarn watch`.) #### Does this fix any issues or need any specific reviewers? Fixes: #1922 Fixes: #2105 Fixes: #646 Fixes: #2109 Fixes: #2107 Fixes: #2018 2018-08-22 18:22:40 -07:00			`## Tools`
add resources to docs 2016-11-18 12:11:59 -08:00
Update resources.md 2018-06-19 11:53:11 -07:00			`These tools are helpful when developing with Slate:`

docs: fix immutablejs doc domain (#2655) 2019-03-26 10:23:53 +08:00			* [Immutable.js Console Extension](https://github.com/mattzeunert/immutable-object-formatter-extension) greatly improves the `console.log` output when working with [Immutable.js](https://immutable-js.github.io/immutable-js/) objects, which Slate's data model is based on.
add showcase to resources 2017-07-20 10:01:59 -07:00
Update resources.md 2018-06-19 11:51:26 -07:00			`## Products`
add showcase to resources 2017-07-20 10:01:59 -07:00
Add controller (#2221) * fold Stack into Editor * switch Change objects to be tied to editors, not values * introduce controller * add the "commands" concept * convert history into commands on `value.data` * add the ability to not normalize on editor creation/setting * convert schema to a mutable constructor * add editor.command method * convert plugin handlers to receive `next` * switch commands to use the onCommand middleware * add queries support, convert schema to queries * split out browser plugin * remove noop util * fixes * fixes * start fixing tests, refactor hyperscript to be more literal * fix slate-html-serializer tests * fix schema tests with hyperscript * fix text model tests with hyperscript * fix more tests * get all tests passing * fix lint * undo decorations example update * update examples * small changes to the api to make it nicer * update docs * update commands/queries plugin logic * change normalizeNode and validateNode to be middleware * fix decoration removal * rename commands tests * add useful errors to existing APIs * update changelogs * cleanup * fixes * update docs * add editor docs 2018-10-09 14:03:27 -07:00			`These products use Slate, and can give you an idea of what's possible:`
Update resources.md 2018-06-19 11:53:11 -07:00
Update products to include Cake (#2207) Now that Cake is coming out of invite only mode, figured it was a good time to add it. :) 2018-09-25 13:29:15 -07:00			`* [Cake](https://www.cake.co/)`
Add Archbee to resources.md (#2994) 2019-09-08 20:04:36 +03:00			`* [Archbee](https://archbee.io)`
Add controller (#2221) * fold Stack into Editor * switch Change objects to be tied to editors, not values * introduce controller * add the "commands" concept * convert history into commands on `value.data` * add the ability to not normalize on editor creation/setting * convert schema to a mutable constructor * add editor.command method * convert plugin handlers to receive `next` * switch commands to use the onCommand middleware * add queries support, convert schema to queries * split out browser plugin * remove noop util * fixes * fixes * start fixing tests, refactor hyperscript to be more literal * fix slate-html-serializer tests * fix schema tests with hyperscript * fix text model tests with hyperscript * fix more tests * get all tests passing * fix lint * undo decorations example update * update examples * small changes to the api to make it nicer * update docs * update commands/queries plugin logic * change normalizeNode and validateNode to be middleware * fix decoration removal * rename commands tests * add useful errors to existing APIs * update changelogs * cleanup * fixes * update docs * add editor docs 2018-10-09 14:03:27 -07:00			`* [Chatterbug](https://chatterbug.com)`
Update resources.md 2018-06-19 11:51:26 -07:00			`* [GitBook](https://www.gitbook.com/)`
Update resources.md 2018-06-30 15:08:28 -07:00			`* [Grafana](https://grafana.com/)`
Fix typo in resources.md (#2484) * Adding Guilded to Products list * Fixing typo 2018-12-05 12:22:37 -08:00			`* [Guilded](https://www.guilded.gg)`
Update resources.md 2018-06-19 12:14:33 -07:00			`* [Guru](https://www.getguru.com/)`
add Netlify CMS to products list (#2478) 2018-12-04 14:07:28 -05:00			`* [Netlify CMS](https://www.netlifycms.org)`
Update resources.md 2018-06-19 11:51:26 -07:00			`* [Outline](https://www.getoutline.com/)`
Add prezly.com to resources.md (#2483) 2018-12-05 05:57:10 +01:00			`* [Prezly](https://www.prezly.com/)`
Add Sanity.io to the list of products (#2441) Hi Ian! Took the liberty to add Sanity.io to the list 🙌 2018-11-19 23:43:43 +01:00			`* [Sanity.io](https://www.sanity.io)`
Add Products: Taskade (#2008) * Add Products: Taskade * Alphabet order * remove empty line 2018-08-01 13:39:32 +08:00			`* [Taskade](https://www.taskade.com/)`
Update resources.md 2018-06-19 12:11:21 -07:00			`* [Yuque](https://www.yuque.com/)`
fix broken core-plugin link in doc and add one item to the products list (#3017) 2019-09-22 01:46:21 +08:00			`* [Thoughts](https://thoughts.teambition.com)`
Update resources.md 2018-06-19 11:51:26 -07:00
			`## Editors`

Update resources.md 2018-06-19 12:14:53 -07:00			`These pre-packaged editors are built on top of Slate, and can be helpful to see how you might structure your code:`
Update resources.md 2018-06-19 11:53:11 -07:00
Update resources.md 2018-06-19 11:54:38 -07:00			`* [Canner Editor](https://github.com/Canner/canner-slate-editor) is a rich text editor.`
Update resources.md 2018-06-19 11:56:20 -07:00			`* [French Press Editor](https://github.com/roast-cms/french-press-editor) is a customizeable editor with offline support.`
Update resources.md 2018-06-19 11:54:38 -07:00			`* [Nossas Editor](http://slate-editor.bonde.org/) is a drop-in WYSIWYG editor.`
			`* [ORY Editor](https://editor.ory.am/) is a self-contained, inline WYSIWYG editor library.`
			`* [Outline Editor](https://github.com/outline/rich-markdown-editor) is the editor that powers the [Outline](https://www.getoutline.com/) wiki.`
Add controller (#2221) * fold Stack into Editor * switch Change objects to be tied to editors, not values * introduce controller * add the "commands" concept * convert history into commands on `value.data` * add the ability to not normalize on editor creation/setting * convert schema to a mutable constructor * add editor.command method * convert plugin handlers to receive `next` * switch commands to use the onCommand middleware * add queries support, convert schema to queries * split out browser plugin * remove noop util * fixes * fixes * start fixing tests, refactor hyperscript to be more literal * fix slate-html-serializer tests * fix schema tests with hyperscript * fix text model tests with hyperscript * fix more tests * get all tests passing * fix lint * undo decorations example update * update examples * small changes to the api to make it nicer * update docs * update commands/queries plugin logic * change normalizeNode and validateNode to be middleware * fix decoration removal * rename commands tests * add useful errors to existing APIs * update changelogs * cleanup * fixes * update docs * add editor docs 2018-10-09 14:03:27 -07:00			`* [Chatterslate](https://github.com/chatterbugapp/chatterslate) helps teach language grammar and more at [Chatterbug](https://chatterbug.com).`

			`(Or, if you have their exact use case, can be a drop-in editor for you.)`