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

update readmes

Browse Source
This commit is contained in:
Ian Storm Taylor
2017-12-02 13:48:51 -08:00
parent ac9965151a
commit 5df62975a9
3 changed files with 10 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
Readme.md
View File

@@ -170,11 +170,6 @@ If you're using Slate for the first time, check out the [Getting Started](http:/
If even that's not enough, you can always [read the source itself](./src), which is heavily commented.
<br/>
### Translations
There are also translations of the documentation into other languages:
- [中文](https://doodlewind.github.io/slate-doc-cn/)

5
docs/Introduction.md
View File

@@ -106,10 +106,7 @@ If you're using Slate for the first time, check out the [Getting Started](http:/
- [**FAQ**](http://docs.slatejs.org/general/faq)
- [**Resources**](http://docs.slatejs.org/general/resources)
If even that's not enough, you can always [read the source itself](./src), which is explained along with a handful of readme's and is heavily commented.
## Translations
If even that's not enough, you can always [read the source itself](./src), which is heavily commented.
There are also translations of the documentation into other languages:

21
packages/Readme.md
View File

@@ -3,15 +3,12 @@
Slate's codebase is monorepo managed with [Lerna](https://lernajs.io/). It consists of a handful of packages—although you won't always use all of them. They are:
- [`slate`](./slate) — which includes Slate's core logic.
- [`slate-react`](./slate) — the React components for rendering Slate editors.
- [`slate-hyperscript`](./slate-hyperscript) — a hyperscript helper to write Slate documents in JSX!
And some others...
- [`slate-base64-serializer`](./slate-base64-serializer) — a Base64 string serializer for Slate documents.
- [`slate-dev-logger`](./slate-logger) — a simpler development-only logger for Slate.
- [`slate-html-serializer`](./slate-html-serializer) — an HTML serializer for Slate documents.
- [`slate-plain-serializer`](./slate-plain-serializer) — a plain text serializer for Slate documents.
- [`slate-prop-types`](./slate-prop-types) — a set of React prop types for checking Slate values.
- [`slate-simulator`](./slate-simulator) — a simulator for testing Slate editors and plugins.
|**Package**|**Version**|**Size**|**Description**|
|[`slate`](./slate)|[![](https://img.shields.io/npm/v/slate.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate/dist/slate.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate/dist/slate.min.js)|Slate's core data model logic.|
|[`slate-base64-serializer`](./slate-base64-serializer)|[![](https://img.shields.io/npm/v/slate-base64-serializer.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-base64-serializer/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-base64-serializer/dist/slate-base64-serializer.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-base64-serializer/dist/slate-base64-serializer.min.js)|A Base64 string serializer for Slate documents.|
|[`slate-html-serializer`](./slate-html-serializer)|[![](https://img.shields.io/npm/v/slate-html-serializer.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-html-serializer/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-html-serializer/dist/slate-html-serializer.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-html-serializer/dist/slate-html-serializer.min.js)|An HTML serializer for Slate documents.|
|[`slate-hyperscript`](./slate-hyperscript)|[![](https://img.shields.io/npm/v/slate-hyperscript.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-hyperscript/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-hyperscript/dist/slate-hyperscript.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-hyperscript/dist/slate-hyperscript.min.js)|A hyperscript helper to write Slate documents in JSX!|
|[`slate-plain-serializer`](./slate-plain-serializer)|[![](https://img.shields.io/npm/v/slate-plain-serializer.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-plain-serializer/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-plain-serializer/dist/slate-plain-serializer.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-plain-serializer/dist/slate-plain-serializer.min.js)|A plain text serializer for Slate documents.|
|[`slate-prop-types`](./slate-prop-types)|[![](https://img.shields.io/npm/v/slate-prop-types.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-prop-types/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-prop-types/dist/slate-prop-types.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-prop-types/dist/slate-prop-types.min.js)|A set of React prop types for checking Slate values.|
|[`slate-react`](./slate-react)|[![](https://img.shields.io/npm/v/slate-react.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-react/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-react/dist/slate-react.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-react/dist/slate-react.min.js)|The React components for rendering Slate editors.|
|[`slate-simulator`](./slate-simulator)|[![](https://img.shields.io/npm/v/slate-simulator.svg?maxAge=2592000&label=version&colorB=007ec6)](./packages/slate-simulator/package.json)|[![](http://img.badgesize.io/https://unpkg.com/slate-simulator/dist/slate-simulator.min.js?compression=gzip&amp;label=size)](https://unpkg.com/slate-simulator/dist/slate-simulator.min.js)|A simulator for testing Slate editors and plugins.|