From a96b4e2f28a903fb022906ef152d965f7f499fb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Ooms?= Date: Fri, 24 Apr 2020 10:02:11 +0200 Subject: [PATCH] :books: docs: Upgrade. --- .esdoc.json | 47 ++++++++++++++++++++++++++++++++++++++ doc/manual/example.md | 1 + doc/manual/installation.md | 1 + doc/manual/overview.md | 1 + doc/manual/usage.md | 7 +++--- esdoc.json | 37 ------------------------------ package.json | 5 ++-- 7 files changed, 57 insertions(+), 42 deletions(-) create mode 100644 .esdoc.json delete mode 100644 esdoc.json diff --git a/.esdoc.json b/.esdoc.json new file mode 100644 index 0000000..b111c65 --- /dev/null +++ b/.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-disjoint-set" + }, + "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"] + } + } + ] +} diff --git a/doc/manual/example.md b/doc/manual/example.md index cc7d869..3c98d5d 100644 --- a/doc/manual/example.md +++ b/doc/manual/example.md @@ -1,3 +1,4 @@ +# Examples ```js // can choose between 8 different implementations // - ForestAmortizedHalving diff --git a/doc/manual/installation.md b/doc/manual/installation.md index 8182043..f3289c4 100644 --- a/doc/manual/installation.md +++ b/doc/manual/installation.md @@ -1,3 +1,4 @@ +# Installation Can be managed using [jspm](http://jspm.io) or [npm](https://github.com/npm/npm). diff --git a/doc/manual/overview.md b/doc/manual/overview.md index e69de29..07dd0c5 100644 --- a/doc/manual/overview.md +++ b/doc/manual/overview.md @@ -0,0 +1 @@ +# Overview diff --git a/doc/manual/usage.md b/doc/manual/usage.md index 56ecf38..b56ee4e 100644 --- a/doc/manual/usage.md +++ b/doc/manual/usage.md @@ -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 diff --git a/esdoc.json b/esdoc.json deleted file mode 100644 index d1c8fce..0000000 --- a/esdoc.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "source": "./src", - "destination": "./gh-pages", - "access": [ - "public", - "protected", - "private" - ], - "debug": false, - "index": "./README.md", - "package": "./package.json", - "title": "aureooms/js-disjoint-set", - "test": { - "type": "ava", - "source": "./test/src" - }, - "manual": { - "overview": [ - "./doc/manual/overview.md" - ], - "installation": [ - "./doc/manual/installation.md" - ], - "usage": [ - "./doc/manual/usage.md" - ], - "example": [ - "./doc/manual/example.md" - ] - }, - "styles": [ - "./doc/css/style.css" - ], - "scripts": [ - "./doc/scripts/header.js" - ] -} diff --git a/package.json b/package.json index e3099a2..305193b 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "babel-preset-latest": "6.24.1", "codeclimate-test-reporter": "0.5.1", "coveralls": "2.13.3", - "esdoc": "0.5.2", + "esdoc": "1.1.0", "nyc": "11.9.0", "@babel/cli": "7.8.4", "@babel/core": "7.9.0", @@ -68,6 +68,7 @@ "build": "babel src -d lib", "cover": "nyc --reporter=lcov npm test", "prepublish": "npm run build", - "test": "ava ./test/src --concurrency 8" + "test": "ava ./test/src --concurrency 8", + "esdoc": "esdoc" } }