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

update docs

Browse Source
This commit is contained in:
Ian Storm Taylor
2016-07-12 22:26:57 -07:00
parent 98b217f616
commit 677ac96f4f
3 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Contributing.md
View File

@@ -6,7 +6,11 @@ Want to contribute to Slate? That would be awesome!
### Running Tests ### Running Tests
To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and run `make install` to install of its dependencies from `npm`. To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`.
```
make install
```
And then build the source and run the tests: And then build the source and run the tests:
@@ -15,6 +19,12 @@ make dist
make test make test
``` ```
And to run the linter:
```
make lint
```
If you need to debug something, you can add a `debugger` line to the source, and then run `make test` with the `DEBUG=true` flag enabled. If you need to debug something, you can add a `debugger` line to the source, and then run `make test` with the `DEBUG=true` flag enabled.
To keep the source rebuilding on every file change, you need to run an additional watching command: To keep the source rebuilding on every file change, you need to run an additional watching command:
@@ -26,7 +36,11 @@ make watch-dist
### Running Examples ### Running Examples
To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and run `make install` to install of its dependencies from `npm`. To run the examples, you need to have the Slate repository cloned to your computed. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`.
```
make install
```
And then build the source and run the examples server: And then build the source and run the examples server:

1
docs/concepts/Readme.md
View File

@@ -6,7 +6,6 @@ This document explain the core concepts that Slate is built on around. It is hel
- [Statelessness & Immutability](./statelessness-and-immutability.md) - [Statelessness & Immutability](./statelessness-and-immutability.md)
- [The Document Model](./the-document-model.md) - [The Document Model](./the-document-model.md)
- [The Selection Model](./the-selection-model.md) - [The Selection Model](./the-selection-model.md)
- [Transforms](./transforms.md)
- [Plugins](./plugins.md) - [Plugins](./plugins.md)

15
examples/index.js
View File

@@ -3,13 +3,6 @@ import React from 'react'
import ReactDOM from 'react-dom' import ReactDOM from 'react-dom'
import { Router, Route, Link, IndexRedirect, hashHistory } from 'react-router' import { Router, Route, Link, IndexRedirect, hashHistory } from 'react-router'
/**
* Perf.
*/
import Perf from 'react-addons-perf'
window.Perf = Perf
/** /**
* Examples. * Examples.
*/ */
@@ -24,6 +17,14 @@ import PlainText from './plain-text'
import RichText from './rich-text' import RichText from './rich-text'
import Tables from './tables' import Tables from './tables'
/**
* Perf.
*/
import Perf from 'react-addons-perf'
window.Perf = Perf
/** /**
* Define our example app. * Define our example app.
* *