1
0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-07-31 20:40:19 +02:00

add more readmes

This commit is contained in:
Ian Storm Taylor
2016-07-06 16:21:05 -07:00
parent 69f990cccb
commit 047488dfbb
3 changed files with 13 additions and 1 deletions

10
lib/Readme.md Normal file
View File

@@ -0,0 +1,10 @@
This directory contains the core logic of Slate. It's separated into a series of directories, each with their own explanitory Readme:
- [**Components**](./components) — containing the React components Slate renders.
- [**Models**](./models) — containing the models that store Slate's data.
- [**Plugins**](./plugins) — containing the plugins that ship with Slate by default.
- [**Serializers**](./serializers) — containing the serializers that ship with Slate by default.
- [**Utils**](./utils) — containing a few convenience utility modules.
Feel free to poke around each of them for more information!

View File

@@ -15,7 +15,7 @@ It handles all of the heavy lifting of actually parsing the HTML, and iterating
#### Raw
The `Raw` serializer is the simplest serializer, which translates a [`State`](../models#state) into JSON.
The `Raw` serializer is the simplest serializer, which translates a [`State`](../models#state) into JSON.
It doesn't just use Immutable.js's [`.toJSON()`](https://facebook.github.io/immutable-js/docs/#/List/toJS) method. Instead, it performs a little bit of "minifying" logic to reduce unnecessary information from being in the raw output.

2
lib/utils/Readme.md Normal file
View File

@@ -0,0 +1,2 @@
This directory contains a series of utilities that Slate uses internally. They're pulled out here to re-use code and to enforce consistency.