Skip to content

Commit d17103c

Browse files
📚 docs: Upgrade.
1 parent 035d4b7 commit d17103c

File tree

5 files changed

+54
-39
lines changed

5 files changed

+54
-39
lines changed

.esdoc.json

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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-standard-plugin",
10+
"option": {
11+
"accessor": {
12+
"access": ["public", "protected", "private"],
13+
"autoPrivate": true
14+
},
15+
"brand": {
16+
"title": "@aureooms/js-permutation"
17+
},
18+
"test": {
19+
"type": "ava",
20+
"source": "./test/src"
21+
},
22+
"manual": {
23+
"files":[
24+
"./doc/manual/overview.md",
25+
"./doc/manual/installation.md",
26+
"./doc/manual/usage.md",
27+
"./doc/manual/example.md"
28+
]
29+
}
30+
}
31+
},
32+
{
33+
"name": "esdoc-inject-style-plugin",
34+
"option": {
35+
"enable": true,
36+
"styles": ["./doc/css/style.css"]
37+
}
38+
},
39+
{
40+
"name": "esdoc-inject-script-plugin",
41+
"option": {
42+
"enable": true,
43+
"scripts": ["./doc/scripts/header.js"]
44+
}
45+
}
46+
]
47+
}

doc/manual/overview.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Overview

doc/manual/usage.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Usage
22

33
The code needs a ES2015+ polyfill to work, for example
4-
[babel-polyfill](https://babeljs.io/docs/usage/polyfill).
4+
[@babel/polyfill](https://babeljs.io/docs/usage/polyfill).
55
```js
6-
require( 'babel-polyfill' ) ;
6+
require( '@babel/polyfill' ) ;
77
// or
8-
import 'babel-polyfill' ;
8+
import '@babel/polyfill' ;
99
```
1010

1111
Then

esdoc.json

-34
This file was deleted.

package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
"babel-preset-env": "^1.4.0",
3737
"codeclimate-test-reporter": "^0.4.1",
3838
"coveralls": "^2.13.1",
39-
"esdoc": "^0.5.2",
39+
"esdoc": "^1.1.0",
4040
"nyc": "^11.0.0",
4141
"@babel/cli": "7.8.4",
4242
"@babel/core": "7.9.0",
@@ -67,6 +67,7 @@
6767
"build": "babel src -d lib",
6868
"cover": "nyc --reporter=lcov npm test",
6969
"prepublish": "npm run build",
70-
"test": "ava ./test/src"
70+
"test": "ava ./test/src",
71+
"esdoc": "esdoc"
7172
}
7273
}

0 commit comments

Comments
 (0)