mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-02-01 13:18:29 +01:00
Code Issues Releases Wiki Activity
slate/docs/Readme.md

72 lines
2.6 KiB
Markdown
Raw Normal View History

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
* [Introduction](./Introduction.md)
update gitbook
2016-08-25 22:32:17 -04:00
change slate to be a monorepo using lerna (#1106) * init lerna, move files into ./packages * move test files into ./packages * more moving around * fill out package.json files * fixing imports * more fixing of imports, and horribleness * convert examples, fix linting errors * add documentation * update docs * get tests passing * update travis.yml * update travis.yml * update travis.yml * update test script * update travis.yml * update scripts * try simplifying travis.yml * ocd stuff * remove slate-core-test-helpers package * add package readmes * update reference docs structure * refactor slate-simulator into its own package * add docs for new packages * update docs * separate benchmarks into packages, and refactor them
2017-09-11 18:11:45 -07:00
## Walkthroughs
update gitbook
2016-08-25 22:32:17 -04:00
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
* [Installing Slate](./walkthroughs/installing-slate.md)
* [Adding Event Handlers](./walkthroughs/adding-event-handlers.md)
* [Defining Custom Block Nodes](./walkthroughs/defining-custom-block-nodes.md)
* [Applying Custom Formatting](./walkthroughs/applying-custom-formatting.md)
* [Using Plugins](./walkthroughs/using-plugins.md)
* [Saving to a Database](./walkthroughs/saving-to-a-database.md)
* [Saving and Loading HTML Content](./walkthroughs/saving-and-loading-html-content.md)
add more to docs intro
2017-03-31 17:18:13 -07:00
update docs
2017-10-17 20:30:11 -07:00
## Guides
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
* [Changes](./guides/changes.md)
* [Data Model](./guides/data-model.md)
* [Plugins](./guides/plugins.md)
* [Rendering](./guides/rendering.md)
* [Schemas](./guides/schemas.md)
update docs
2017-10-17 20:30:11 -07:00
change slate to be a monorepo using lerna (#1106) * init lerna, move files into ./packages * move test files into ./packages * more moving around * fill out package.json files * fixing imports * more fixing of imports, and horribleness * convert examples, fix linting errors * add documentation * update docs * get tests passing * update travis.yml * update travis.yml * update travis.yml * update test script * update travis.yml * update scripts * try simplifying travis.yml * ocd stuff * remove slate-core-test-helpers package * add package readmes * update reference docs structure * refactor slate-simulator into its own package * add docs for new packages * update docs * separate benchmarks into packages, and refactor them
2017-09-11 18:11:45 -07:00
## General
add more to docs intro
2017-03-31 17:18:13 -07:00
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
* [Plugins](./general/plugins.md)
* [Resources](./general/resources.md)
* [Contributing](../Contributing.md)
* [Changelog](./general/changelog.md)
* [FAQ](./general/faq.md)
add start of glossary (#1946) This is the start of a glossary in the docs for terms that folks might not know when first learning Slate. Hopefully it makes it easier to learn. If anyone wants to help fill it out, that would be amazing. Thanks!
2018-07-02 10:27:35 -06:00
* [Glossary](./general/glossary.md)
add more to docs intro
2017-03-31 17:18:13 -07:00
update docs
2017-09-11 19:36:46 -07:00
## Slate Core
add more to docs intro
2017-03-31 17:18:13 -07:00
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
* [Block](./reference/slate/block.md)
* [Change](./reference/slate/change.md)
* [Data](./reference/slate/data.md)
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
* [Decoration](./reference/slate/decoration.md)
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
* [Document](./reference/slate/document.md)
* [Inline](./reference/slate/inline.md)
* [Mark](./reference//slate/mark.md)
* [Node](./reference/slate/node.md)
* [Operation](./reference/slate/operation.md)
Add a `Point` model, and standardize Range/Point logic (#2035) * add `Node.createRange` for range resolution * fix lint * fix range offset defaults to be `null` * change `isBackward` to be computed from paths * remove debuggers * add point model, update range with deprecations, update hyperscript * got all tests passing * get tests passing, convert changes * fix lint * fix examples * update deprecations * update docs * update slate-react point utils * fix document.normalizeRange * fix lint
2018-08-03 14:45:40 -07:00
* [Point](./reference/slate/point.md)
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
* [Range](./reference/slate/range.md)
* [Schema](./reference/slate/schema.md)
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
* [Selection](./reference/slate/selection.md)
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
* [Text](./reference/slate/text.md)
* [Value](./reference/slate/value.md)
* [setKeyGenerator](./reference/slate/utils.md)
* [resetKeyGenerator](./reference/slate/utils.md)
add more to docs intro
2017-03-31 17:18:13 -07:00
update docs
2017-09-11 19:36:46 -07:00
## Slate React
add more to docs intro
2017-03-31 17:18:13 -07:00
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
* [Editor](./reference/slate-react/editor.md)
* [Plugins](./reference/slate-react/plugins.md)
* [Custom Nodes](./reference/slate-react/custom-nodes.md)
* [Core Plugins](./reference/slate-react/core-plugins.md)
* [cloneFragment](./reference/slate-react/utils.md)
* [findDOMNode](./reference/slate-react/utils.md)
* [findDOMRange](./reference/slate-react/utils.md)
* [findNode](./reference/slate-react/utils.md)
* [findRange](./reference/slate-react/utils.md)
* [getEventRange](./reference/slate-react/utils.md)
* [getEventTransfer](./reference/slate-react/utils.md)
* [setEventTransfer](./reference/slate-react/utils.md)
add more to docs intro
2017-03-31 17:18:13 -07:00
change slate to be a monorepo using lerna (#1106) * init lerna, move files into ./packages * move test files into ./packages * more moving around * fill out package.json files * fixing imports * more fixing of imports, and horribleness * convert examples, fix linting errors * add documentation * update docs * get tests passing * update travis.yml * update travis.yml * update travis.yml * update test script * update travis.yml * update scripts * try simplifying travis.yml * ocd stuff * remove slate-core-test-helpers package * add package readmes * update reference docs structure * refactor slate-simulator into its own package * add docs for new packages * update docs * separate benchmarks into packages, and refactor them
2017-09-11 18:11:45 -07:00
## Other Packages
add more to docs intro
2017-03-31 17:18:13 -07:00
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
* [`slate-html-serializer`](./reference/slate-html-serializer/index.md)
* [`slate-hyperscript`](./reference/slate-hyperscript/index.md)
* [`slate-plain-serializer`](./reference/slate-plain-serializer/index.md)
* [`slate-prop-types`](./reference/slate-prop-types/index.md)
* [`slate-simulator`](./reference/slate-simulator/index.md)
Reference in New Issue Copy Permalink