Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Remove Typedoc #5

Merged
merged 1 commit into from
Jan 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"build": "tsc -p tsconfig.prod.json",
"check": "yarn compile && yarn lint && yarn test",
"compile": "tsc",
"docs": "typedoc",
"lint": "eslint . --report-unused-disable-directives",
"test": "NODE_ENV=test mocha"
},
Expand Down Expand Up @@ -65,9 +64,6 @@
"sinon": "^17.0.1",
"ts-node": "^10.9.2",
"tslib": "^2.6.2",
"typedoc": "^0.25.7",
"typedoc-plugin-markdown": "^3.17.1",
"typedoc-plugin-merge-modules": "^5.1.0",
"typescript": "^5.3.3"
},
"peerDependencies": {
Expand Down
27 changes: 0 additions & 27 deletions typedoc.json

This file was deleted.

137 changes: 4 additions & 133 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2405,13 +2405,6 @@ __metadata:
languageName: node
linkType: hard

"ansi-sequence-parser@npm:^1.1.0":
version: 1.1.1
resolution: "ansi-sequence-parser@npm:1.1.1"
checksum: 9ce30f257badc2ef62cac8028a7e26c368d22bf26650427192e8ffd102da42e377e3affe90fae58062eecc963b0b055f510dde3b677c7e0c433c67069b5a8ee5
languageName: node
linkType: hard

"ansi-styles@npm:^3.2.0, ansi-styles@npm:^3.2.1":
version: 3.2.1
resolution: "ansi-styles@npm:3.2.1"
Expand Down Expand Up @@ -4450,24 +4443,6 @@ __metadata:
languageName: node
linkType: hard

"handlebars@npm:^4.7.7":
version: 4.7.8
resolution: "handlebars@npm:4.7.8"
dependencies:
minimist: "npm:^1.2.5"
neo-async: "npm:^2.6.2"
source-map: "npm:^0.6.1"
uglify-js: "npm:^3.1.4"
wordwrap: "npm:^1.0.0"
dependenciesMeta:
uglify-js:
optional: true
bin:
handlebars: bin/handlebars
checksum: bd528f4dd150adf67f3f857118ef0fa43ff79a153b1d943fa0a770f2599e38b25a7a0dbac1a3611a4ec86970fd2325a81310fb788b5c892308c9f8743bd02e11
languageName: node
linkType: hard

"has-bigints@npm:^1.0.1, has-bigints@npm:^1.0.2":
version: 1.0.2
resolution: "has-bigints@npm:1.0.2"
Expand Down Expand Up @@ -5346,13 +5321,6 @@ __metadata:
languageName: node
linkType: hard

"jsonc-parser@npm:^3.2.0":
version: 3.2.1
resolution: "jsonc-parser@npm:3.2.1"
checksum: fe2df6f39e21653781d52cae20c5b9e0ab62461918d97f9430b216cea9b6500efc1d8b42c6584cc0a7548b4c996055e9cdc39f09b9782fa6957af2f45306c530
languageName: node
linkType: hard

"jsonfile@npm:^4.0.0":
version: 4.0.0
resolution: "jsonfile@npm:4.0.0"
Expand Down Expand Up @@ -5544,13 +5512,6 @@ __metadata:
languageName: node
linkType: hard

"lunr@npm:^2.3.9":
version: 2.3.9
resolution: "lunr@npm:2.3.9"
checksum: f2f6db34c046f5a767782fe2454e6dd69c75ba3c5cf5c1cb9cacca2313a99c2ba78ff8fa67dac866fb7c4ffd5f22e06684793f5f15ba14bddb598b94513d54bf
languageName: node
linkType: hard

"make-dir@npm:^2.0.0, make-dir@npm:^2.1.0":
version: 2.1.0
resolution: "make-dir@npm:2.1.0"
Expand Down Expand Up @@ -5596,15 +5557,6 @@ __metadata:
languageName: node
linkType: hard

"marked@npm:^4.3.0":
version: 4.3.0
resolution: "marked@npm:4.3.0"
bin:
marked: bin/marked.js
checksum: c830bb4cb3705b754ca342b656e8a582d7428706b2678c898b856f6030c134ce2d1e19136efa3e6a1841f7330efbd24963d6bdeddc57d2938e906250f99895d0
languageName: node
linkType: hard

"marky@npm:^1.2.2":
version: 1.2.5
resolution: "marky@npm:1.2.5"
Expand Down Expand Up @@ -5918,7 +5870,7 @@ __metadata:
languageName: node
linkType: hard

"minimatch@npm:9.0.3, minimatch@npm:^9.0.1, minimatch@npm:^9.0.3":
"minimatch@npm:9.0.3, minimatch@npm:^9.0.1":
version: 9.0.3
resolution: "minimatch@npm:9.0.3"
dependencies:
Expand All @@ -5945,7 +5897,7 @@ __metadata:
languageName: node
linkType: hard

"minimist@npm:^1.2.0, minimist@npm:^1.2.5, minimist@npm:^1.2.6":
"minimist@npm:^1.2.0, minimist@npm:^1.2.6":
version: 1.2.8
resolution: "minimist@npm:1.2.8"
checksum: 908491b6cc15a6c440ba5b22780a0ba89b9810e1aea684e253e43c4e3b8d56ec1dcdd7ea96dde119c29df59c936cde16062159eae4225c691e19c70b432b6e6f
Expand Down Expand Up @@ -6132,7 +6084,7 @@ __metadata:
languageName: node
linkType: hard

"neo-async@npm:^2.5.0, neo-async@npm:^2.6.2":
"neo-async@npm:^2.5.0":
version: 2.6.2
resolution: "neo-async@npm:2.6.2"
checksum: 1a7948fea86f2b33ec766bc899c88796a51ba76a4afc9026764aedc6e7cde692a09067031e4a1bf6db4f978ccd99e7f5b6c03fe47ad9865c3d4f99050d67e002
Expand Down Expand Up @@ -6823,9 +6775,6 @@ __metadata:
sinon: "npm:^17.0.1"
ts-node: "npm:^10.9.2"
tslib: "npm:^2.6.2"
typedoc: "npm:^0.25.7"
typedoc-plugin-markdown: "npm:^3.17.1"
typedoc-plugin-merge-modules: "npm:^5.1.0"
typescript: "npm:^5.3.3"
peerDependencies:
react: ">=18.2.0"
Expand Down Expand Up @@ -7398,18 +7347,6 @@ __metadata:
languageName: node
linkType: hard

"shiki@npm:^0.14.7":
version: 0.14.7
resolution: "shiki@npm:0.14.7"
dependencies:
ansi-sequence-parser: "npm:^1.1.0"
jsonc-parser: "npm:^3.2.0"
vscode-oniguruma: "npm:^1.7.0"
vscode-textmate: "npm:^8.0.0"
checksum: be3f2444c65bd0c57802026f171cb42ad571d361ee885be0c292b60785f68c70f19b69310f5ffe7f7a93db4c5ef50211e0a0248794bc6bb48d242bc43fe72a62
languageName: node
linkType: hard

"side-channel@npm:^1.0.4":
version: 1.0.4
resolution: "side-channel@npm:1.0.4"
Expand Down Expand Up @@ -7519,7 +7456,7 @@ __metadata:
languageName: node
linkType: hard

"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1":
"source-map@npm:^0.6.0, source-map@npm:~0.6.1":
version: 0.6.1
resolution: "source-map@npm:0.6.1"
checksum: 59ef7462f1c29d502b3057e822cdbdae0b0e565302c4dd1a95e11e793d8d9d62006cdc10e0fd99163ca33ff2071360cf50ee13f90440806e7ed57d81cba2f7ff
Expand Down Expand Up @@ -8079,42 +8016,6 @@ __metadata:
languageName: node
linkType: hard

"typedoc-plugin-markdown@npm:^3.17.1":
version: 3.17.1
resolution: "typedoc-plugin-markdown@npm:3.17.1"
dependencies:
handlebars: "npm:^4.7.7"
peerDependencies:
typedoc: ">=0.24.0"
checksum: 21bfe7fba60e3c27e15700196b1b4abdf5b63bfdc9a4af57cf6f0891f9d359ac561435773709c6ea3555bae402b7a81b637d055e767afd33e2c0dc717d0449d2
languageName: node
linkType: hard

"typedoc-plugin-merge-modules@npm:^5.1.0":
version: 5.1.0
resolution: "typedoc-plugin-merge-modules@npm:5.1.0"
peerDependencies:
typedoc: 0.24.x || 0.25.x
checksum: 4ff170c03cf0942eb2184515ffb1ddb4bfb7990ee7d7d51b5a0fcf63297f997dba72321696abe57237887b28b5e9d2902806f3d450a1171923f78551042cf5d7
languageName: node
linkType: hard

"typedoc@npm:^0.25.7":
version: 0.25.7
resolution: "typedoc@npm:0.25.7"
dependencies:
lunr: "npm:^2.3.9"
marked: "npm:^4.3.0"
minimatch: "npm:^9.0.3"
shiki: "npm:^0.14.7"
peerDependencies:
typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x
bin:
typedoc: bin/typedoc
checksum: fa88c808e9912ef248cc45b4defea49522e93b97b4bb67423670257a4507ccabdc25c1518a39f6058a728d08675ee0947de55944419fa4bb9f870d84ba4db764
languageName: node
linkType: hard

"typescript@npm:^5.3.3":
version: 5.3.3
resolution: "typescript@npm:5.3.3"
Expand All @@ -8135,15 +8036,6 @@ __metadata:
languageName: node
linkType: hard

"uglify-js@npm:^3.1.4":
version: 3.17.4
resolution: "uglify-js@npm:3.17.4"
bin:
uglifyjs: bin/uglifyjs
checksum: 4c0b800e0ff192079d2c3ce8414fd3b656a570028c7c79af5c29c53d5c532b68bbcae4ad47307f89c2ee124d11826fff7a136b59d5c5bb18422bcdf5568afe1e
languageName: node
linkType: hard

"unbox-primitive@npm:^1.0.2":
version: 1.0.2
resolution: "unbox-primitive@npm:1.0.2"
Expand Down Expand Up @@ -8284,20 +8176,6 @@ __metadata:
languageName: node
linkType: hard

"vscode-oniguruma@npm:^1.7.0":
version: 1.7.0
resolution: "vscode-oniguruma@npm:1.7.0"
checksum: 7da9d21459f9788544b258a5fd1b9752df6edd8b406a19eea0209c6bf76507d5717277016799301c4da0d536095f9ca8c06afd1ab8f4001189090c804ca4814e
languageName: node
linkType: hard

"vscode-textmate@npm:^8.0.0":
version: 8.0.0
resolution: "vscode-textmate@npm:8.0.0"
checksum: 9fa7d66d6042cb090d116c2d8820d34c8870cfcbaed6e404da89f66b899970ed0ac47b59a2e30fc40a25af5414822bb3ea27974f714e9b91910d69c894be95f7
languageName: node
linkType: hard

"walker@npm:^1.0.7":
version: 1.0.8
resolution: "walker@npm:1.0.8"
Expand Down Expand Up @@ -8395,13 +8273,6 @@ __metadata:
languageName: node
linkType: hard

"wordwrap@npm:^1.0.0":
version: 1.0.0
resolution: "wordwrap@npm:1.0.0"
checksum: 497d40beb2bdb08e6d38754faa17ce20b0bf1306327f80cb777927edb23f461ee1f6bc659b3c3c93f26b08e1cf4b46acc5bae8fda1f0be3b5ab9a1a0211034cd
languageName: node
linkType: hard

"workerpool@npm:6.2.1":
version: 6.2.1
resolution: "workerpool@npm:6.2.1"
Expand Down
Loading