mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-08-21 14:41:23 +02:00
update gitbook
This commit is contained in:
@@ -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).
|
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)
|
- [Installing Slate](./docs/walkthroughs/installing-slate.md)
|
||||||
- [Using the Bundled Source](./docs/walkthroughs/using-the-bundled-source.md)
|
- [Using the Bundled Source](./docs/walkthroughs/using-the-bundled-source.md)
|
||||||
- [Adding Event Handlers](./docs/walkthroughs/adding-event-handlers.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)
|
- [Using Plugins](./docs/walkthroughs/using-plugins.md)
|
||||||
- [Saving to a Database](./docs/walkthroughs/saving-to-a-database.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)
|
- [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)
|
- [**Reference**](./docs/reference)
|
||||||
- Components
|
- Components
|
||||||
- [Editor](./docs/reference/components/editor.md)
|
- [Editor](./docs/reference/components/editor.md)
|
||||||
|
@@ -1,4 +1,8 @@
|
|||||||
{
|
{
|
||||||
"root": "./docs",
|
"root": "./docs",
|
||||||
"plugins": ["-highlight", "prism"]
|
"plugins": ["-highlight", "prism"],
|
||||||
|
"structure": {
|
||||||
|
"readme": "./Readme.md",
|
||||||
|
"summary": "./Summary.md"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
10
docs/Readme.md
Normal file
10
docs/Readme.md
Normal file
@@ -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._
|
38
docs/Summary.md
Normal file
38
docs/Summary.md
Normal file
@@ -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)
|
Reference in New Issue
Block a user