Skip to content

Commit e66f04c

Browse files
committedSep 20, 2020
📚 docs: Upgrade.
1 parent 99e0578 commit e66f04c

File tree

7 files changed

+65
-42
lines changed

7 files changed

+65
-42
lines changed
 

‎.esdoc.json

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
}

‎doc/manual/example.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Examples
12
```js
23
import array from "@aureooms/js-array" ;
34
import search from "@aureooms/js-search" ;

‎doc/manual/installation.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Installation
12
Can be managed using
23
[jspm](http://jspm.io)
34
or [npm](https://github.com/npm/npm).

‎doc/manual/overview.md

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

‎doc/manual/usage.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
# Usage
12
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).
34
```js
4-
require( 'babel-polyfill' ) ;
5+
require( '@babel/polyfill' ) ;
56
// or
6-
import 'babel-polyfill' ;
7+
import '@babel/polyfill' ;
78
```
89

910
Then

‎esdoc.json

-37
This file was deleted.

‎package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"babel-preset-latest": "^6.22.0",
3838
"codeclimate-test-reporter": "^0.4.1",
3939
"coveralls": "^2.11.16",
40-
"esdoc": "^0.5.2",
40+
"esdoc": "^1.1.0",
4141
"nyc": "^11.0.1",
4242
"@babel/cli": "7.11.6",
4343
"@babel/core": "7.11.6",
@@ -72,6 +72,7 @@
7272
"build": "babel src -d lib",
7373
"cover": "nyc --reporter=lcov npm test",
7474
"prepublish": "npm run build",
75-
"test": "ava ./test/src"
75+
"test": "ava ./test/src",
76+
"esdoc": "esdoc"
7677
}
7778
}

0 commit comments

Comments
 (0)
Please sign in to comment.