From 68b81106e6216b4f1e23f35a64c38eddf9b63663 Mon Sep 17 00:00:00 2001 From: garrettmills Date: Tue, 29 Nov 2022 11:00:08 -0600 Subject: [PATCH] Docs: update to latest typedoc (breaks theme) --- .drone.yml | 1 + docs/HOME.md | 2 +- docs/pages/About-Extollo.md | 1 - docs/pages/Getting-Started.md | 1 - package.json | 5 +- pnpm-lock.yaml | 141 ++++++++++++++++++++++------------ typedoc.json | 13 +++- 7 files changed, 104 insertions(+), 60 deletions(-) diff --git a/.drone.yml b/.drone.yml index 7c5250d..c611779 100644 --- a/.drone.yml +++ b/.drone.yml @@ -26,6 +26,7 @@ steps: image: docker:latest privileged: true commands: + - "while ! docker stats --no-stream; do sleep 1; done" - docker image build docs -t $DOCKER_REGISTRY/extollo/docs:latest - docker push $DOCKER_REGISTRY/extollo/docs:latest environment: diff --git a/docs/HOME.md b/docs/HOME.md index 54b43b9..a24ea33 100644 --- a/docs/HOME.md +++ b/docs/HOME.md @@ -22,7 +22,7 @@ Node.js provides an excellent platform for quickly getting an application up and ## Getting Started Writing an application with Extollo is very straightforward if you are familiar with Node.js/TypeScript, or similar frameworks like Laravel. -Check out the [Getting Started](https://extollo.garrettmills.dev/pages/Documentation/Getting-Started.html) page site for more information. +Check out the [Getting Started](pages/Getting-Started.html) page site for more information. ## License & Philosophy The Extollo project is, and will always be, free & libre software. The framework itself is open-source available [here](https://code.garrettmills.dev/Extollo), and is licensed under the terms of the MIT license. See the LICENSE file for more information. diff --git a/docs/pages/About-Extollo.md b/docs/pages/About-Extollo.md index 53174b6..e69de29 100644 --- a/docs/pages/About-Extollo.md +++ b/docs/pages/About-Extollo.md @@ -1 +0,0 @@ -# About the Extollo Project diff --git a/docs/pages/Getting-Started.md b/docs/pages/Getting-Started.md index 02aba44..7419914 100644 --- a/docs/pages/Getting-Started.md +++ b/docs/pages/Getting-Started.md @@ -1,4 +1,3 @@ -# Getting Started with Extollo ## Requirements diff --git a/package.json b/package.json index 589102a..0a6a37a 100644 --- a/package.json +++ b/package.json @@ -46,9 +46,6 @@ "sqlite3": "^5.1.1", "ssh2": "^1.11.0", "ts-node": "^10.9.1", - "typedoc": "^0.23.15", - "typedoc-plugin-pages-fork": "^0.0.1", - "typedoc-plugin-sourcefile-url": "^1.0.6", "typescript": "^4.8.4", "uuid": "^8.3.2", "ws": "^8.9.0", @@ -76,6 +73,7 @@ "author": "garrettmills ", "license": "MIT", "devDependencies": { + "@knodes/typedoc-plugin-pages": "^0.23.1", "@types/chai": "^4.3.3", "@types/mocha": "^9.0.0", "@types/sinon": "^10.0.13", @@ -86,6 +84,7 @@ "eslint": "^8.24.0", "mocha": "^9.1.3", "sinon": "^12.0.1", + "typedoc": "^0.23.21", "wtfnode": "^0.9.1" }, "extollo": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 159817c..dba7189 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -3,6 +3,7 @@ lockfileVersion: 5.4 specifiers: '@atao60/fse-cli': ^0.1.7 '@extollo/ui': ^0.1.0 + '@knodes/typedoc-plugin-pages': ^0.23.1 '@types/bcrypt': ^5.0.0 '@types/busboy': ^0.2.3 '@types/chai': ^4.3.3 @@ -49,9 +50,7 @@ specifiers: sqlite3: ^5.1.1 ssh2: ^1.11.0 ts-node: ^10.9.1 - typedoc: ^0.23.15 - typedoc-plugin-pages-fork: ^0.0.1 - typedoc-plugin-sourcefile-url: ^1.0.6 + typedoc: ^0.23.21 typescript: ^4.8.4 uuid: ^8.3.2 ws: ^8.9.0 @@ -97,15 +96,13 @@ dependencies: sqlite3: 5.1.1 ssh2: 1.11.0 ts-node: 10.9.1_fk6arlf3j7tudlucddpzvj2plq - typedoc: 0.23.15_typescript@4.8.4 - typedoc-plugin-pages-fork: 0.0.1 - typedoc-plugin-sourcefile-url: 1.0.6_typedoc@0.23.15 typescript: 4.8.4 uuid: 8.3.2 ws: 8.9.0 zod: 3.19.1 devDependencies: + '@knodes/typedoc-plugin-pages': 0.23.1_typedoc@0.23.21 '@types/chai': 4.3.3 '@types/mocha': 9.1.1 '@types/sinon': 10.0.13 @@ -116,6 +113,7 @@ devDependencies: eslint: 8.24.0 mocha: 9.2.2 sinon: 12.0.1 + typedoc: 0.23.21_typescript@4.8.4 wtfnode: 0.9.1 packages: @@ -260,6 +258,28 @@ packages: '@jridgewell/sourcemap-codec': 1.4.14 dev: false + /@knodes/typedoc-plugin-pages/0.23.1_typedoc@0.23.21: + resolution: {integrity: sha512-Zhe4ZTDbnxBNZir/aB4dP7WMaF4k8Idx/DlwJAizvhL6cv0a7W+ulpG2eTweU7R4B3uaiKoR9+c0Yulfq0W/9g==} + peerDependencies: + lunr: ^2.3.0 + typedoc: ^0.23.0 + dependencies: + '@knodes/typedoc-pluginutils': 0.23.1_typedoc@0.23.21 + lodash: 4.17.21 + typedoc: 0.23.21_typescript@4.8.4 + dev: true + + /@knodes/typedoc-pluginutils/0.23.1_typedoc@0.23.21: + resolution: {integrity: sha512-WjGG7bSFpZ0um6R1Lr5bnQuDROgwHOCcbjeXpAHjFjrTpTXsQgmzkcK36ybhMLh9VBqjt5m1MK41pClpUzqYEA==} + peerDependencies: + typedoc: ^0.23.0 + dependencies: + lodash: 4.17.21 + pkg-up: 3.1.0 + semver: 7.3.7 + typedoc: 0.23.21_typescript@4.8.4 + dev: true + /@mapbox/node-pre-gyp/1.0.10: resolution: {integrity: sha512-4ySo4CjzStuprMwk35H5pPbkymjv1SF3jGLj6rAHp/xT/RF7TL7bd9CTm1xDY49K2qF7jmR/g7k+SkLETP6opA==} hasBin: true @@ -848,7 +868,7 @@ packages: resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} dependencies: balanced-match: 1.0.2 - dev: false + dev: true /braces/3.0.2: resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==} @@ -1064,10 +1084,6 @@ packages: engines: {node: '>=0.1.90'} dev: false - /compare-versions/3.6.0: - resolution: {integrity: sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA==} - dev: false - /concat-map/0.0.1: resolution: {integrity: sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=} @@ -1463,6 +1479,13 @@ packages: to-regex-range: 5.0.1 dev: true + /find-up/3.0.0: + resolution: {integrity: sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==} + engines: {node: '>=6'} + dependencies: + locate-path: 3.0.0 + dev: true + /find-up/5.0.0: resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} engines: {node: '>=10'} @@ -1911,7 +1934,7 @@ packages: /jsonc-parser/3.2.0: resolution: {integrity: sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==} - dev: false + dev: true /jsonfile/6.1.0: resolution: {integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==} @@ -1971,6 +1994,14 @@ packages: type-check: 0.4.0 dev: true + /locate-path/3.0.0: + resolution: {integrity: sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==} + engines: {node: '>=6'} + dependencies: + p-locate: 3.0.0 + path-exists: 3.0.0 + dev: true + /locate-path/6.0.0: resolution: {integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==} engines: {node: '>=10'} @@ -2028,7 +2059,6 @@ packages: /lodash/4.17.21: resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} - dev: false /log-symbols/4.1.0: resolution: {integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==} @@ -2051,7 +2081,7 @@ packages: /lunr/2.3.9: resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} - dev: false + dev: true /make-dir/3.1.0: resolution: {integrity: sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==} @@ -2090,11 +2120,11 @@ packages: dev: false optional: true - /marked/4.1.0: - resolution: {integrity: sha512-+Z6KDjSPa6/723PQYyc1axYZpYYpDnECDaU6hkaf5gqBieBkMKYReL5hteF2QizhlMbgbo8umXl/clZ67+GlsA==} + /marked/4.2.3: + resolution: {integrity: sha512-slWRdJkbTZ+PjkyJnE30Uid64eHwbwa1Q25INCAYfZlK4o6ylagBy/Le9eWntqJFoFT93ikUKMv47GZ4gTwHkw==} engines: {node: '>= 12'} hasBin: true - dev: false + dev: true /merge2/1.4.1: resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} @@ -2143,7 +2173,7 @@ packages: engines: {node: '>=10'} dependencies: brace-expansion: 2.0.1 - dev: false + dev: true /minipass-collect/1.0.2: resolution: {integrity: sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==} @@ -2419,6 +2449,13 @@ packages: engines: {node: '>=0.10.0'} dev: false + /p-limit/2.3.0: + resolution: {integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==} + engines: {node: '>=6'} + dependencies: + p-try: 2.2.0 + dev: true + /p-limit/3.1.0: resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} engines: {node: '>=10'} @@ -2426,6 +2463,13 @@ packages: yocto-queue: 0.1.0 dev: true + /p-locate/3.0.0: + resolution: {integrity: sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==} + engines: {node: '>=6'} + dependencies: + p-limit: 2.3.0 + dev: true + /p-locate/5.0.0: resolution: {integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==} engines: {node: '>=10'} @@ -2446,6 +2490,11 @@ packages: dev: false optional: true + /p-try/2.2.0: + resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} + engines: {node: '>=6'} + dev: true + /packet-reader/1.0.0: resolution: {integrity: sha512-HAKu/fG3HpHFO0AA8WE8q2g+gBJaZ9MG7fcKk+IJPLTGAD6Psw4443l+9DGRbOIh3/aXr7Phy0TjilYivJo5XQ==} dev: false @@ -2457,6 +2506,11 @@ packages: callsites: 3.1.0 dev: true + /path-exists/3.0.0: + resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==} + engines: {node: '>=4'} + dev: true + /path-exists/4.0.0: resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==} engines: {node: '>=8'} @@ -2551,6 +2605,13 @@ packages: engines: {node: '>=8.6'} dev: true + /pkg-up/3.1.0: + resolution: {integrity: sha512-nDywThFk1i4BQK4twPQ6TA4RT8bDY96yeuCVBWL3ePARCiEKDRSrNGbFIgUJpLp+XeIR65v8ra7WuJOFUBtkMA==} + engines: {node: '>=8'} + dependencies: + find-up: 3.0.0 + dev: true + /pluralize/8.0.0: resolution: {integrity: sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==} engines: {node: '>=4'} @@ -2870,9 +2931,9 @@ packages: resolution: {integrity: sha512-EugY9VASFuDqOexOgXR18ZV+TbFrQHeCpEYaXamO+SZlsnT/2LxuLBX25GGtIrwaEVFXUAbUQ601SWE2rMwWHA==} dependencies: jsonc-parser: 3.2.0 - vscode-oniguruma: 1.6.2 + vscode-oniguruma: 1.7.0 vscode-textmate: 6.0.0 - dev: false + dev: true /signal-exit/3.0.7: resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} @@ -3175,41 +3236,19 @@ packages: engines: {node: '>=10'} dev: false - /typedoc-default-themes/0.10.2: - resolution: {integrity: sha512-zo09yRj+xwLFE3hyhJeVHWRSPuKEIAsFK5r2u47KL/HBKqpwdUSanoaz5L34IKiSATFrjG5ywmIu98hPVMfxZg==} - engines: {node: '>= 8'} - dependencies: - lunr: 2.3.9 - dev: false - - /typedoc-plugin-pages-fork/0.0.1: - resolution: {integrity: sha512-WZoTOSarUL1CPO7LJOpsltP6B8Qrx3Tc0/hjZVNRe5mwvZnU1/LAz12ERyKzA/TsR1iIpiaixzkbhIwYkICGiQ==} - dependencies: - compare-versions: 3.6.0 - typedoc-default-themes: 0.10.2 - dev: false - - /typedoc-plugin-sourcefile-url/1.0.6_typedoc@0.23.15: - resolution: {integrity: sha512-xHq9DzkoQywS7FyPneMm2/Hr9GRoCpjSQXkVN0W6SCJKP7fguqg2tasgh+8l5/mW6YSYvqCqEbkSYLbuD4Y6gA==} - peerDependencies: - typedoc: '>=0.16.0' - dependencies: - typedoc: 0.23.15_typescript@4.8.4 - dev: false - - /typedoc/0.23.15_typescript@4.8.4: - resolution: {integrity: sha512-x9Zu+tTnwxb9YdVr+zvX7LYzyBl1nieOr6lrSHbHsA22/RJK2m4Y525WIg5Mj4jWCmfL47v6f4hUzY7EIuwS5w==} + /typedoc/0.23.21_typescript@4.8.4: + resolution: {integrity: sha512-VNE9Jv7BgclvyH9moi2mluneSviD43dCE9pY8RWkO88/DrEgJZk9KpUk7WO468c9WWs/+aG6dOnoH7ccjnErhg==} engines: {node: '>= 14.14'} hasBin: true peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x + typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x dependencies: lunr: 2.3.9 - marked: 4.1.0 + marked: 4.2.3 minimatch: 5.1.0 shiki: 0.11.1 typescript: 4.8.4 - dev: false + dev: true /typescript/4.8.4: resolution: {integrity: sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==} @@ -3259,13 +3298,13 @@ packages: engines: {node: '>=0.10.0'} dev: false - /vscode-oniguruma/1.6.2: - resolution: {integrity: sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==} - dev: false + /vscode-oniguruma/1.7.0: + resolution: {integrity: sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==} + dev: true /vscode-textmate/6.0.0: resolution: {integrity: sha512-gu73tuZfJgu+mvCSy4UZwd2JXykjK9zAZsfmDeut5dx/1a7FeTk0XwJsSuqQn+cuMCGVbIBfl+s53X4T19DnzQ==} - dev: false + dev: true /wcwidth/1.0.1: resolution: {integrity: sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==} diff --git a/typedoc.json b/typedoc.json index ef9fa71..68f3998 100644 --- a/typedoc.json +++ b/typedoc.json @@ -2,10 +2,17 @@ "name": "The Extollo Framework", "readme": "./docs/HOME.md", "tsconfig": "tsconfig.json", - "sourcefile-url-map": "./docs/sourcefile-map.json", - "theme": "./docs/theme", + "hideGenerator": true, + "sourceLinkTemplate": "https://code.garrettmills.dev/extollo/lib/src/commit/{gitRevision}/{path}#L{line}", "out": "./docs/www", "entryPoints": [ "src/index.ts" - ] + ], + "pluginPages": { + "source": "docs/pages", + "pages": [ + {"title": "Getting Started", "source": "Getting-Started.md"}, + {"title": "About Extollo", "source": "About-Extollo.md"} + ] + } }