From 88cee8993a9d0ae5eaa8350011c9357e37d0a21d Mon Sep 17 00:00:00 2001 From: Yarmo Mackenbach Date: Sat, 24 Apr 2021 12:15:58 +0200 Subject: [PATCH] Change jsdoc theme --- jsdoc-lib.json | 20 ++++++++++++++++---- package.json | 2 +- yarn.lock | 41 ++++++++++++++++++++++++++++++++++++----- 3 files changed, 53 insertions(+), 10 deletions(-) diff --git a/jsdoc-lib.json b/jsdoc-lib.json index 7cea1d6..52a3044 100644 --- a/jsdoc-lib.json +++ b/jsdoc-lib.json @@ -12,9 +12,21 @@ } }, "opts": { - "template": "node_modules/docdash" - }, - "docdash": { - "search": true + "template": "node_modules/clean-jsdoc-theme", + "theme_opts": { + "theme": "light", + "menu" : [ + { + "title": "Source code", + "link": "https://codeberg.org/keyoxide/doipjs", + "target": "_blank" + }, + { + "title": "Keyoxide", + "link": "https://keyoxide.org", + "target": "_blank" + } + ] + } } } diff --git a/package.json b/package.json index 9a92a90..506b105 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,7 @@ "chai": "^4.2.0", "chai-as-promised": "^7.1.1", "chai-match-pattern": "^1.2.0", - "docdash": "^1.2.0", + "clean-jsdoc-theme": "^3.2.4", "jsdoc": "^3.6.6", "license-check-and-add": "^3.0.4", "minify": "^6.0.1", diff --git a/yarn.lock b/yarn.lock index 3a490c1..22128b0 100644 --- a/yarn.lock +++ b/yarn.lock @@ -808,6 +808,11 @@ asynckit@^0.4.0: resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" integrity sha1-x57Zf380y48robyXkLzDZkdLS3k= +at-least-node@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/at-least-node/-/at-least-node-1.0.0.tgz#602cd4b46e844ad4effc92a8011a3c46e0238dc2" + integrity sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg== + atob@^2.1.2: version "2.1.2" resolved "https://registry.yarnpkg.com/atob/-/atob-2.1.2.tgz#6d9517eb9e030d2436666651e86bd9f6f13533c9" @@ -1404,6 +1409,13 @@ clean-css@^4.1.6, clean-css@^4.2.3: dependencies: source-map "~0.6.0" +clean-jsdoc-theme@^3.2.4: + version "3.2.4" + resolved "https://registry.yarnpkg.com/clean-jsdoc-theme/-/clean-jsdoc-theme-3.2.4.tgz#a8d5173ed746b9ddc8f19d31754e6e741f31209c" + integrity sha512-DV/0oZI0sxJLDhF9W+u2LBvm9XJFW94wwb+cSebZf6zHgpE8+Gg7XqfY/NMpNIKSjdqIEVecjtveBnkxR2GkQw== + dependencies: + fs-extra "^9.1.0" + cli-boxes@^2.2.0: version "2.2.1" resolved "https://registry.yarnpkg.com/cli-boxes/-/cli-boxes-2.2.1.tgz#ddd5035d25094fce220e9cab40a45840a440318f" @@ -1872,11 +1884,6 @@ dir-glob@^3.0.1: dependencies: path-type "^4.0.0" -docdash@^1.2.0: - version "1.2.0" - resolved "https://registry.yarnpkg.com/docdash/-/docdash-1.2.0.tgz#f99dde5b8a89aa4ed083a3150383e042d06c7f49" - integrity sha512-IYZbgYthPTspgqYeciRJNPhSwL51yer7HAwDXhF5p+H7mTDbPvY3PCk/QDjNxdPCpWkaJVFC4t7iCNB/t9E5Kw== - domain-browser@^1.2.0: version "1.2.0" resolved "https://registry.yarnpkg.com/domain-browser/-/domain-browser-1.2.0.tgz#3d31f50191a6749dd1375a7f522e823d42e54eda" @@ -2431,6 +2438,16 @@ fs-extra@^8.1.0: jsonfile "^4.0.0" universalify "^0.1.0" +fs-extra@^9.1.0: + version "9.1.0" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.1.0.tgz#5954460c764a8da2094ba3554bf839e6b9a7c86d" + integrity sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ== + dependencies: + at-least-node "^1.0.0" + graceful-fs "^4.2.0" + jsonfile "^6.0.1" + universalify "^2.0.0" + fs-readdir-recursive@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/fs-readdir-recursive/-/fs-readdir-recursive-1.1.0.tgz#e32fc030a2ccee44a6b5371308da54be0b397d27" @@ -3360,6 +3377,15 @@ jsonfile@^4.0.0: optionalDependencies: graceful-fs "^4.1.6" +jsonfile@^6.0.1: + version "6.1.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-6.1.0.tgz#bc55b2634793c679ec6403094eb13698a6ec0aae" + integrity sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ== + dependencies: + universalify "^2.0.0" + optionalDependencies: + graceful-fs "^4.1.6" + jsonparse@^1.2.0: version "1.3.1" resolved "https://registry.yarnpkg.com/jsonparse/-/jsonparse-1.3.1.tgz#3f4dae4a91fac315f71062f8521cc239f1366280" @@ -5392,6 +5418,11 @@ universalify@^0.1.0, universalify@^0.1.2: resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66" integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg== +universalify@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-2.0.0.tgz#75a4984efedc4b08975c5aeb73f530d02df25717" + integrity sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ== + unpipe@1.0.0, unpipe@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec"