Skip to content

Commit f13866b

Browse files
📚 docs: Upgrade.
1 parent f78a534 commit f13866b

File tree

7 files changed

+56
-41
lines changed

7 files changed

+56
-41
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-collections-defaultdict"
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/example.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Examples
12
See Python's docs:
23

34
- [defaultdict](https://docs.python.org/3/library/collections.html#collections.defaultdict)

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@
7777
"build": "rm -rf lib && babel src -d lib",
7878
"cover": "nyc --reporter=lcov npm test",
7979
"prepublish": "npm run build",
80-
"test": "ava ./test/src"
80+
"test": "ava ./test/src",
81+
"esdoc": "esdoc"
8182
}
8283
}

0 commit comments

Comments
 (0)