Skip to content

Commit

Permalink
📚 docs: Upgrade.
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Apr 28, 2020
1 parent f78a534 commit f13866b
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 41 deletions.
47 changes: 47 additions & 0 deletions .esdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"source": "./src",
"destination": "./gh-pages",
"debug": false,
"index": "./README.md",
"package": "./package.json",
"plugins": [
{
"name": "esdoc-standard-plugin",
"option": {
"accessor": {
"access": ["public", "protected", "private"],
"autoPrivate": true
},
"brand": {
"title": "@aureooms/js-collections-defaultdict"
},
"test": {
"type": "ava",
"source": "./test/src"
},
"manual": {
"files":[
"./doc/manual/overview.md",
"./doc/manual/installation.md",
"./doc/manual/usage.md",
"./doc/manual/example.md"
]
}
}
},
{
"name": "esdoc-inject-style-plugin",
"option": {
"enable": true,
"styles": ["./doc/css/style.css"]
}
},
{
"name": "esdoc-inject-script-plugin",
"option": {
"enable": true,
"scripts": ["./doc/scripts/header.js"]
}
}
]
}
1 change: 1 addition & 0 deletions doc/manual/example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Examples
See Python's docs:

- [defaultdict](https://docs.python.org/3/library/collections.html#collections.defaultdict)
1 change: 1 addition & 0 deletions doc/manual/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Installation
Can be managed using
[jspm](http://jspm.io)
or [npm](https://github.com/npm/npm).
Expand Down
1 change: 1 addition & 0 deletions doc/manual/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview
7 changes: 4 additions & 3 deletions doc/manual/usage.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Usage
The code needs a ES2015+ polyfill to work, for example
[babel-polyfill](https://babeljs.io/docs/usage/polyfill).
[@babel/polyfill](https://babeljs.io/docs/usage/polyfill).
```js
require( 'babel-polyfill' ) ;
require( '@babel/polyfill' ) ;
// or
import 'babel-polyfill' ;
import '@babel/polyfill' ;
```

Then
Expand Down
37 changes: 0 additions & 37 deletions esdoc.json

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"build": "rm -rf lib && babel src -d lib",
"cover": "nyc --reporter=lcov npm test",
"prepublish": "npm run build",
"test": "ava ./test/src"
"test": "ava ./test/src",
"esdoc": "esdoc"
}
}

0 comments on commit f13866b

Please sign in to comment.