mirror of
https://github.com/ianstormtaylor/slate.git
synced 2025-09-01 19:22:35 +02:00
add more docs
This commit is contained in:
15
Readme.md
15
Readme.md
@@ -50,21 +50,22 @@ If you have an idea for an example that shows a common use case, pull request it
|
||||
<br/>
|
||||
### Documentation
|
||||
|
||||
If you're using Slate for the first time, check out the [Getting Started](./docs/getting-started) guide 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/guides/installing-slate.md) guides 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).
|
||||
|
||||
- [**Getting Started**](docs/getting-started.md)
|
||||
- Installing Slate
|
||||
- Adding Slate to Your App
|
||||
- Customizing Slate's Behavior
|
||||
- [**Guides**](docs/guides/installing-slate.md)
|
||||
- [Installing Slate](docs/guides/installing-slate.md)
|
||||
- [Adding Event Handlers](docs/guides/adding-event-handlers.md)
|
||||
- [Adding Custom Formatting](docs/guides/adding-custom-formatting.md)
|
||||
- [Adding Custom Block Types](docs/guides/adding-custom-block-types.md)
|
||||
- Adding Plugins
|
||||
|
||||
- [**Core Concepts**](docs/concepts.md)
|
||||
- [**Concepts**](docs/concepts.md)
|
||||
- Statelessness & Immutability
|
||||
- [The Document Model](docs/getting-started.md#the-document-model)
|
||||
- The Selection Model
|
||||
- Plugins
|
||||
|
||||
- **API Reference**
|
||||
- **Reference**
|
||||
- Components
|
||||
- Editor
|
||||
- Models
|
||||
|
10
docs/guides/Readme.md
Normal file
10
docs/guides/Readme.md
Normal file
@@ -0,0 +1,10 @@
|
||||
|
||||
These guides introduce you to the different parts of Slate in a step-by-step way that build on each other, perfect for getting started. We recommend reading them in order, start to finish!
|
||||
|
||||
- [Installing Slate](./installing-slate.md)
|
||||
- [Adding Event Handlers](./adding-event-handlers.md)
|
||||
- [Adding Custom Formatting](./adding-custom-formatting.md)
|
||||
- [Adding Custom Block Types](./adding-custom-block-types.md)
|
||||
- Adding Plugins
|
||||
|
||||
_If you have an idea for a guide, or notice something that isn't clear, submit a pull request!_
|
@@ -114,7 +114,7 @@ Pretty simple, right?
|
||||
|
||||
And now, let's tell Slate about that mark. To do that, we'll need to pass in a `renderMark` function to the `Editor`, which it will call with any mark it finds. And when it calls it with a bold mark, we'll return our `BOLD_MARK` styles. Like so:
|
||||
|
||||
```
|
||||
```js
|
||||
const BOLD_MARK = {
|
||||
fontWeight: 'bold'
|
||||
}
|
Reference in New Issue
Block a user