File tree 7 files changed +65
-42
lines changed
7 files changed +65
-42
lines changed Original file line number Diff line number Diff line change
1
+ {
2
+ "source" : " ./src" ,
3
+ "destination" : " ./gh-pages" ,
4
+ "debug" : false ,
5
+ "index" : " ./README.md" ,
6
+ "package" : " ./package.json" ,
7
+ "plugins" : [
8
+ {
9
+ "name" : " esdoc-inject-script-plugin" ,
10
+ "option" : {
11
+ "enable" : true ,
12
+ "scripts" : [
13
+ " ./doc/scripts/header.js"
14
+ ]
15
+ }
16
+ },
17
+ {
18
+ "name" : " esdoc-inject-style-plugin" ,
19
+ "option" : {
20
+ "enable" : true ,
21
+ "styles" : [
22
+ " ./doc/css/style.css"
23
+ ]
24
+ }
25
+ },
26
+ {
27
+ "name" : " esdoc-standard-plugin" ,
28
+ "option" : {
29
+ "accessor" : {
30
+ "access" : [
31
+ " public" ,
32
+ " protected" ,
33
+ " private"
34
+ ],
35
+ "autoPrivate" : true
36
+ },
37
+ "brand" : {
38
+ "title" : " @aureooms/js-sort"
39
+ },
40
+ "test" : {
41
+ "type" : " ava" ,
42
+ "source" : " ./test/src"
43
+ },
44
+ "manual" : {
45
+ "files" : [
46
+ " ./doc/manual/overview.md" ,
47
+ " ./doc/manual/installation.md" ,
48
+ " ./doc/manual/usage.md" ,
49
+ " ./doc/manual/example.md"
50
+ ]
51
+ }
52
+ }
53
+ }
54
+ ]
55
+ }
Original file line number Diff line number Diff line change
1
+ # Examples
1
2
``` js
2
3
import array from " @aureooms/js-array" ;
3
4
import search from " @aureooms/js-search" ;
Original file line number Diff line number Diff line change
1
+ # Installation
1
2
Can be managed using
2
3
[ jspm] ( http://jspm.io )
3
4
or [ npm] ( https://github.com/npm/npm ) .
Original file line number Diff line number Diff line change
1
+ # Overview
Original file line number Diff line number Diff line change
1
+ # Usage
1
2
The code needs a ES2015+ polyfill to work, for example
2
- [ babel- polyfill] ( https://babeljs.io/docs/usage/polyfill ) .
3
+ [ @ babel/ polyfill ] ( https://babeljs.io/docs/usage/polyfill ) .
3
4
``` js
4
- require ( ' babel- polyfill' ) ;
5
+ require ( ' @ babel/ polyfill' ) ;
5
6
// or
6
- import ' babel- polyfill' ;
7
+ import ' @ babel/ polyfill' ;
7
8
```
8
9
9
10
Then
Load Diff This file was deleted.
Original file line number Diff line number Diff line change 37
37
"babel-preset-latest" : " ^6.22.0" ,
38
38
"codeclimate-test-reporter" : " ^0.4.1" ,
39
39
"coveralls" : " ^2.11.16" ,
40
- "esdoc" : " ^0.5.2 " ,
40
+ "esdoc" : " ^1.1.0 " ,
41
41
"nyc" : " ^11.0.1" ,
42
42
"@babel/cli" : " 7.11.6" ,
43
43
"@babel/core" : " 7.11.6" ,
72
72
"build" : " babel src -d lib" ,
73
73
"cover" : " nyc --reporter=lcov npm test" ,
74
74
"prepublish" : " npm run build" ,
75
- "test" : " ava ./test/src"
75
+ "test" : " ava ./test/src" ,
76
+ "esdoc" : " esdoc"
76
77
}
77
78
}
You can’t perform that action at this time.
0 commit comments