Skip to content

Commit 32b09db

Browse files
committed
docs: improve docs
1 parent 3df9906 commit 32b09db

File tree

3 files changed

+24
-23
lines changed

3 files changed

+24
-23
lines changed

docs/en/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`libreact` is a collection of most essential React utilities you will probably need in any project.
44

5-
[Render prop](#render-props) and [FaCC](#facc) notation is usually used interchangeably as most `libreact`
5+
[Render prop](#render-props) and [FaCC](#facc) notation is used interchangeably as most `libreact`
66
components support both interfaces. Also, most render prop components support
77
[component prop](#component-prop) interface, with the following precedence:
88

docs/en/WidthSensor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# `WidthSensor`
1+
# `<WidthSensor>`
22

3-
FaCC that works similar to [`SizeSensor`](./SizeSensor.md) but re-renders only on width change.
3+
FaCC that works similar to [`<SizeSensor>`](./SizeSensor.md) but re-renders only on width change.
44

55
## Example
66

77
Use it as FaCC
88

99
```jsx
10-
[`withSize()`](./docs/SizeSensor.md#withsize-hoc), and [`@withSize`](./docs/SizeSensor.md#withsize-decorator)
10+
import {WidthSensor} from 'libreact/lib/WidthSensor';
1111

1212
<WidthSensor>{({width, height}) =>
1313
`WIDTH: ${width}, HEIGHT: ${height}`

package.json

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
{
22
"name": "libreact",
3-
"version": "0.5.9",
3+
"version": "0.5.11",
44
"description": "React standard library",
55
"main": "lib/index.js",
66
"repository": {
77
"type": "git",
88
"url": "https://github.com/MailOnline/libreact.git"
99
},
10+
"scripts": {
11+
"clean": "rimraf lib modules && npm run test:story:clean && npm run docs:clean",
12+
"build": "npm run clean && gulp build-ts && gulp build-modules",
13+
"start": "npm run test:story",
14+
"semantic-release": "semantic-release",
15+
"test": "npm run test:server && npm run test:client",
16+
"test:server": "mocha -r ts-node/register src/**/*.test-server.ts*",
17+
"test:client": "jest",
18+
"test:client:coverage": "jest --coverage",
19+
"test:watch": "jest --watch",
20+
"test:story:clean": "rimraf storybook-static",
21+
"test:story": "start-storybook -p 6007",
22+
"test:story:build": "build-storybook",
23+
"docs:clean": "rimraf dist_docs docs/_book",
24+
"docs:serve": "npm run docs:clean && gitbook install ./docs && gitbook serve ./docs",
25+
"docs:build": "npm run docs:clean && gitbook install ./docs && gitbook build ./docs",
26+
"docs:publish": "npm run test:story:build && npm run docs:build && ./build/publish-docs.sh"
27+
},
1028
"dependencies": {
1129
"throttle-debounce": "^1.0.1",
1230
"freestyler-context": "^1.3.3",
@@ -62,24 +80,6 @@
6280
"path": "./node_modules/mol-conventional-changelog"
6381
}
6482
},
65-
"scripts": {
66-
"clean": "rimraf lib modules && npm run test:story:clean && npm run docs:clean",
67-
"build": "npm run clean && gulp build-ts && gulp build-modules",
68-
"start": "npm run test:story",
69-
"semantic-release": "semantic-release",
70-
"test": "npm run test:server && npm run test:client",
71-
"test:server": "mocha -r ts-node/register src/**/*.test-server.ts*",
72-
"test:client": "jest",
73-
"test:client:coverage": "jest --coverage",
74-
"test:watch": "jest --watch",
75-
"test:story:clean": "rimraf storybook-static",
76-
"test:story": "start-storybook -p 6007",
77-
"test:story:build": "build-storybook",
78-
"docs:clean": "rimraf dist_docs docs/_book",
79-
"docs:serve": "npm run docs:clean && gitbook install ./docs && gitbook serve ./docs",
80-
"docs:build": "npm run docs:clean && gitbook install ./docs && gitbook build ./docs",
81-
"docs:publish": "npm run test:story:build && npm run docs:build && ./build/publish-docs.sh"
82-
},
8383
"jest": {
8484
"moduleFileExtensions": [
8585
"ts",
@@ -102,6 +102,7 @@
102102
},
103103
"keywords": [
104104
"react",
105+
"lib",
105106
"libreact",
106107
"stdlib",
107108
"hoc",

0 commit comments

Comments
 (0)