diff --git a/Readme.md b/Readme.md index 478d5b8d4..dad9b2638 100644 --- a/Readme.md +++ b/Readme.md @@ -106,7 +106,7 @@ Slate encourages you to write small, reusable modules. Check out the public ones If you're using Slate for the first time, check out the [Getting Started](./docs/walkthroughs/installing-slate.md) walkthroughs and the [Core Concepts](./docs/concepts) to familiarize yourself with Slate's architecture and mental models. Once you've gotten familiar with those, you'll probably want to check out the full [API Reference](./docs/reference). -- [**Walkthroughts**](./docs/walkthroughs) +- [**Walkthroughs**](./docs/walkthroughs) - [Installing Slate](./docs/walkthroughs/installing-slate.md) - [Using the Bundled Source](./docs/walkthroughs/using-the-bundled-source.md) - [Adding Event Handlers](./docs/walkthroughs/adding-event-handlers.md) @@ -115,11 +115,6 @@ If you're using Slate for the first time, check out the [Getting Started](./docs - [Using Plugins](./docs/walkthroughs/using-plugins.md) - [Saving to a Database](./docs/walkthroughs/saving-to-a-database.md) - [Saving and Loading HTML Content](./docs/walkthroughs/saving-and-loading-html-content.md) -- [**Concepts**](./docs/concepts) - - [Statelessness & Immutability](./docs/concepts/statelessness-and-immutability.md) - - [The Document Model](./docs/concepts/the-document-model.md) - - [The Selection Model](./docs/concepts/the-selection-model.md) - - [Plugins](./docs/concepts/plugins.md) - [**Reference**](./docs/reference) - Components - [Editor](./docs/reference/components/editor.md) diff --git a/book.json b/book.json index 301501a7d..4011aaa40 100644 --- a/book.json +++ b/book.json @@ -1,4 +1,8 @@ { - "root": "./docs", - "plugins": ["-highlight", "prism"] + "root": "./docs", + "plugins": ["-highlight", "prism"], + "structure": { + "readme": "./Readme.md", + "summary": "./Summary.md" + } } diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 000000000..ebe308b03 --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,10 @@ + +# Introduction + +Slate is a _completely_ customizable framework for building rich text editors. + +Slate lets you build rich, intuitive editors like those in [Medium](https://medium.com/), [Dropbox Paper](https://www.dropbox.com/paper) or [Canvas](https://usecanvas.com/)—which are becoming table stakes for applications on the web—without your codebase getting mired in complexity. + +It can do this because all of its logic is implemented with a series of plugins, so you aren't ever constrained by what _is_ or _isn't_ in "core". You can think of it like a pluggable implementation of `contenteditable` built on top of [React](https://facebook.github.io/react/) and [Immutable](https://facebook.github.io/immutable-js/). It was inspired by libraries like [Draft.js](https://facebook.github.io/draft-js/), [Prosemirror](http://prosemirror.net/) and [Quill](http://quilljs.com/). + +_**Slate is currently in beta**. It's useable now, but you might need to pull request a fix or two for advanced use cases._ diff --git a/docs/Summary.md b/docs/Summary.md new file mode 100644 index 000000000..d6d01a68e --- /dev/null +++ b/docs/Summary.md @@ -0,0 +1,38 @@ + +## Walkthroughs + +- [Installing Slate](./walkthroughs/installing-slate.md) +- [Using the Bundled Source](./walkthroughs/using-the-bundled-source.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) + + +## Reference + +- Components + - [Editor](./reference/components/editor.md) + - [Placeholder](./reference/components/placeholder.md) +- Models + - [Block](./reference/models/block.md) + - [Character](./reference/models/character.md) + - [Data](./reference//models/data.md) + - [Document](./reference/models/document.md) + - [Inline](./reference/models/inline.md) + - [Mark](./reference//models/mark.md) + - [Node](./reference/models/node.md) + - [Selection](./reference/models/selection.md) + - [State](./reference/models/state.md) + - [Text](./reference//models/text.md) + - [Transform](./reference/models/transform.md) +- Serializers + - [Html](./reference/serializers/html.md) + - [Plain](./reference/serializers/plain.md) + - [Raw](./reference/serializers/raw.md) +- Plugins + - [Plugins](./reference/plugins/plugins.md) + - [Core](./reference/plugins/core.md) +- [FAQ](./concepts/faq.md)