Skip to content

Commit

Permalink
😒 chore(docs): Upgrade esdoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Apr 16, 2020
1 parent 3e95968 commit dfd5464
Show file tree
Hide file tree
Showing 8 changed files with 308 additions and 40 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-binomial-heap"
},
"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

```js
// can choose between 3 different implementations
Expand Down
2 changes: 2 additions & 0 deletions doc/manual/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 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
2 changes: 2 additions & 0 deletions doc/manual/usage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Usage

The code needs a ES2015+ polyfill to work, for example
[babel-polyfill](https://babeljs.io/docs/usage/polyfill).
```js
Expand Down
33 changes: 0 additions & 33 deletions esdoc.json

This file was deleted.

5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@
"ava": "3.7.0",
"coveralls": "3.0.11",
"esdoc": "1.1.0",
"esdoc-ecmascript-proposal-plugin": "1.0.0",
"esdoc-inject-script-plugin": "1.0.0",
"esdoc-inject-style-plugin": "1.0.0",
"esdoc-standard-plugin": "1.0.0",
"nyc": "15.0.1"
},
"files": [
Expand All @@ -64,6 +68,7 @@
"scripts": {
"build": "babel src -d lib",
"cover": "nyc --reporter=lcov npm test",
"esdoc": "esdoc",
"prepublish": "npm run build",
"test": "ava"
}
Expand Down
Loading

0 comments on commit dfd5464

Please sign in to comment.