📚 docs: Upgrade.

Author: make-github-pseudonymous-again

.esdoc.json

@@ -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-dll"
+        },
+        "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"]
+      }
+    }
+  ]
+}

doc/css/style.css

@@ -0,0 +1,52 @@
+h1,
+h2,
+.navigation,
+.layout-container > header,
+footer
+{
+	border: none;
+}
+
+.project-name {
+  color: #FC913A;
+  font-weight: bold;
+}
+
+.layout-container > header > a.repo-url-github {
+    font-size: inherit;
+    display: inline;
+    background: none;
+    vertical-align: inherit;
+}
+
+.search-box img {
+	display: none;
+}
+
+.search-box::before{
+	content: "search";
+}
+
+.search-input-edge {
+	height: 0px;
+}
+
+.search-result {
+    width: 300px;
+    margin-left: 42px;
+	box-shadow: 1px 1px 13px rgba(0,0,0,0.2);
+}
+
+.search-input {
+	visibility: visible;
+}
+
+.search-result li.search-separator {
+	text-transform: capitalize;
+	background-color: #ccc;
+}
+
+span[data-ice="signature"] > span {
+	/*font-weight: bold;*/
+	font-style: italic;
+}

doc/manual/example.md

@@ -0,0 +1,3 @@
+# Examples
+
+> More examples in [the test files](https://github.com/aureooms/js-dll/tree/master/test/src).

doc/manual/installation.md

@@ -0,0 +1,22 @@
+# Installation
+
+Can be managed using
+[yarn](https://yarnpkg.com/en/docs),
+[npm](https://docs.npmjs.com),
+or [jspm](https://jspm.org/docs).
+
+
+### yarn
+```terminal
+yarn add @aureooms/js-dll
+```
+
+### npm
+```terminal
+npm install @aureooms/js-dll --save
+```
+
+### jspm
+```terminal
+jspm install npm:@aureooms/js-dll
+```

doc/manual/overview.md

@@ -0,0 +1 @@
+# Overview

doc/manual/usage.md

@@ -0,0 +1,18 @@
+# Usage
+
+> :warning: The code needs a ES2015+ polyfill to run (`regeneratorRuntime`),
+> for instance [@babel/polyfill](https://babeljs.io/docs/usage/polyfill).
+
+First, require the polyfill at the entry point of your application
+```js
+require( '@babel/polyfill' ) ;
+// or
+import '@babel/polyfill' ;
+```
+
+Then, import the library where needed
+```js
+const dll = require( '@aureooms/js-dll' ) ;
+// or
+import * as dll from '@aureooms/js-dll' ;
+```

doc/scripts/header.js

@@ -0,0 +1,34 @@
+var domReady = function(callback) {
+	var state = document.readyState ;
+    if ( state === 'interactive' || state === 'complete' ) {
+		callback() ;
+	}
+	else {
+		document.addEventListener('DOMContentLoaded', callback);
+	}
+} ;
+
+
+domReady(function(){
+
+	var projectname = document.createElement('a');
+	projectname.classList.add('project-name');
+	projectname.text = 'aureooms/js-dll';
+	projectname.href = './index.html' ;
+
+	var header = document.getElementsByTagName('header')[0] ;
+	header.insertBefore(projectname,header.firstChild);
+
+	var testlink = document.querySelector('header > a[data-ice="testLink"]') ;
+	testlink.href = 'https://coveralls.io/github/aureooms/js-dll' ;
+	testlink.target = '_BLANK' ;
+
+	var searchBox = document.querySelector('.search-box');
+	var input = document.querySelector('.search-input');
+
+	// active search box when focus on searchBox.
+	input.addEventListener('focus', function(){
+		searchBox.classList.add('active');
+	});
+
+});

package.json

@@ -25,7 +25,7 @@
   "scripts": {
     "build": "./node_modules/.bin/aureooms-node-package-build",
     "test": "./node_modules/.bin/aureooms-node-package-test",
-    "doc": "./node_modules/.bin/groc"
+    "esdoc": "esdoc"
   },
   "author": "aureooms",
   "devDependencies": {