Skip to content

Commit aefc8c4

Browse files
authored
docs: bump typedoc plugin, add Docusaurus admonition support (#1705)
Bumps `@apify/docusaurus-plugin-typedoc-api` to use the changes from apify/docusaurus-plugin-typedoc-api#65 . The plugin now supports admonitional docstring sections. Closes #1700
1 parent 3c575bc commit aefc8c4

File tree

2 files changed

+93
-11
lines changed

2 files changed

+93
-11
lines changed

website/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"lint:code:fix": "eslint . --fix"
2222
},
2323
"dependencies": {
24-
"@apify/docusaurus-plugin-typedoc-api": "^5.0.0",
24+
"@apify/docusaurus-plugin-typedoc-api": "^5.1.0",
2525
"@apify/utilities": "^2.8.0",
2626
"@docusaurus/core": "^3.9.2",
2727
"@docusaurus/faster": "^3.9.2",

website/yarn.lock

Lines changed: 92 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -183,11 +183,13 @@ __metadata:
183183
languageName: node
184184
linkType: hard
185185

186-
"@apify/docusaurus-plugin-typedoc-api@npm:^5.0.0":
187-
version: 5.0.0
188-
resolution: "@apify/docusaurus-plugin-typedoc-api@npm:5.0.0"
186+
"@apify/docusaurus-plugin-typedoc-api@npm:^5.1.0":
187+
version: 5.1.0
188+
resolution: "@apify/docusaurus-plugin-typedoc-api@npm:5.1.0"
189189
dependencies:
190+
"@docusaurus/theme-common": "npm:^3.9.2"
190191
"@vscode/codicons": "npm:^0.0.35"
192+
cheerio: "npm:^1.2.0"
191193
html-entities: "npm:2.3.2"
192194
marked: "npm:^9.1.6"
193195
marked-smartypants: "npm:^1.1.5"
@@ -204,7 +206,7 @@ __metadata:
204206
react: ">=18.0.0 || >=19.0.0"
205207
react-dom: ^18.2.0 || >=19.0.0
206208
typescript: ^5.0.0
207-
checksum: 10c0/47da5403fb24790873fb0ccc822e0c7bf521041d5f0d0e5b87eba89dbc1579d12f49d4f5710c609edc152833ce42db39a664c94987566af624b239a642e53698
209+
checksum: 10c0/aa7ae1b833f74d70290f6d4b9dcae43ff57e769b9357a76fed49d13efc06f8dcfdb2b5d3faa131be6ad7ca353721789f8b9630a1686f2bfd563f780f132dab83
208210
languageName: node
209211
linkType: hard
210212

@@ -2743,7 +2745,7 @@ __metadata:
27432745
languageName: node
27442746
linkType: hard
27452747

2746-
"@docusaurus/theme-common@npm:3.9.2":
2748+
"@docusaurus/theme-common@npm:3.9.2, @docusaurus/theme-common@npm:^3.9.2":
27472749
version: 3.9.2
27482750
resolution: "@docusaurus/theme-common@npm:3.9.2"
27492751
dependencies:
@@ -6823,6 +6825,25 @@ __metadata:
68236825
languageName: node
68246826
linkType: hard
68256827

6828+
"cheerio@npm:^1.2.0":
6829+
version: 1.2.0
6830+
resolution: "cheerio@npm:1.2.0"
6831+
dependencies:
6832+
cheerio-select: "npm:^2.1.0"
6833+
dom-serializer: "npm:^2.0.0"
6834+
domhandler: "npm:^5.0.3"
6835+
domutils: "npm:^3.2.2"
6836+
encoding-sniffer: "npm:^0.2.1"
6837+
htmlparser2: "npm:^10.1.0"
6838+
parse5: "npm:^7.3.0"
6839+
parse5-htmlparser2-tree-adapter: "npm:^7.1.0"
6840+
parse5-parser-stream: "npm:^7.1.2"
6841+
undici: "npm:^7.19.0"
6842+
whatwg-mimetype: "npm:^4.0.0"
6843+
checksum: 10c0/91a566aabfa9962f28056045bb7d92d79c0f8f3abb1fb86a852a9d1760556adddeb01a36b6f08fa7c133282375d387ae450a181a659e76c6a64016c30cc3f611
6844+
languageName: node
6845+
linkType: hard
6846+
68266847
"chevrotain-allstar@npm:~0.3.0":
68276848
version: 0.3.1
68286849
resolution: "chevrotain-allstar@npm:0.3.1"
@@ -7266,7 +7287,7 @@ __metadata:
72667287
version: 0.0.0-use.local
72677288
resolution: "crawlee@workspace:."
72687289
dependencies:
7269-
"@apify/docusaurus-plugin-typedoc-api": "npm:^5.0.0"
7290+
"@apify/docusaurus-plugin-typedoc-api": "npm:^5.1.0"
72707291
"@apify/eslint-config-ts": "npm:^0.4.0"
72717292
"@apify/tsconfig": "npm:^0.1.0"
72727293
"@apify/ui-icons": "npm:^1.23.0"
@@ -8453,7 +8474,7 @@ __metadata:
84538474
languageName: node
84548475
linkType: hard
84558476

8456-
"domutils@npm:^3.0.1":
8477+
"domutils@npm:^3.0.1, domutils@npm:^3.2.2":
84578478
version: 3.2.2
84588479
resolution: "domutils@npm:3.2.2"
84598480
dependencies:
@@ -8593,6 +8614,16 @@ __metadata:
85938614
languageName: node
85948615
linkType: hard
85958616

8617+
"encoding-sniffer@npm:^0.2.1":
8618+
version: 0.2.1
8619+
resolution: "encoding-sniffer@npm:0.2.1"
8620+
dependencies:
8621+
iconv-lite: "npm:^0.6.3"
8622+
whatwg-encoding: "npm:^3.1.1"
8623+
checksum: 10c0/d6b591880788f3baf8dd1744636dd189d24a1ec93e6f9817267c60ac3458a5191ca70ab1a186fb67731beff1c3489c6527dfdc4718158ed8460ab2f400dd5e7d
8624+
languageName: node
8625+
linkType: hard
8626+
85968627
"encoding@npm:^0.1.13":
85978628
version: 0.1.13
85988629
resolution: "encoding@npm:0.1.13"
@@ -8633,6 +8664,13 @@ __metadata:
86338664
languageName: node
86348665
linkType: hard
86358666

8667+
"entities@npm:^7.0.1":
8668+
version: 7.0.1
8669+
resolution: "entities@npm:7.0.1"
8670+
checksum: 10c0/b4fb9937bb47ecb00aaaceb9db9cdd1cc0b0fb649c0e843d05cf5dbbd2e9d2df8f98721d8b1b286445689c72af7b54a7242fc2d63ef7c9739037a8c73363e7ca
8671+
languageName: node
8672+
linkType: hard
8673+
86368674
"env-paths@npm:^2.2.0":
86378675
version: 2.2.1
86388676
resolution: "env-paths@npm:2.2.1"
@@ -10610,6 +10648,18 @@ __metadata:
1061010648
languageName: node
1061110649
linkType: hard
1061210650

10651+
"htmlparser2@npm:^10.1.0":
10652+
version: 10.1.0
10653+
resolution: "htmlparser2@npm:10.1.0"
10654+
dependencies:
10655+
domelementtype: "npm:^2.3.0"
10656+
domhandler: "npm:^5.0.3"
10657+
domutils: "npm:^3.2.2"
10658+
entities: "npm:^7.0.1"
10659+
checksum: 10c0/36394e29b80cfcc5e78e0fa4d3aa21fdaac3e6778d23e5c933e625c290987cd9a724a2eb0753ab60ed0c69dfaba0ab115f0ee50fb112fd8f0c4d522e7e0089a2
10660+
languageName: node
10661+
linkType: hard
10662+
1061310663
"htmlparser2@npm:^6.1.0":
1061410664
version: 6.1.0
1061510665
resolution: "htmlparser2@npm:6.1.0"
@@ -10754,7 +10804,7 @@ __metadata:
1075410804
languageName: node
1075510805
linkType: hard
1075610806

10757-
"iconv-lite@npm:0.6, iconv-lite@npm:^0.6.2":
10807+
"iconv-lite@npm:0.6, iconv-lite@npm:0.6.3, iconv-lite@npm:^0.6.2, iconv-lite@npm:^0.6.3":
1075810808
version: 0.6.3
1075910809
resolution: "iconv-lite@npm:0.6.3"
1076010810
dependencies:
@@ -13897,7 +13947,7 @@ __metadata:
1389713947
languageName: node
1389813948
linkType: hard
1389913949

13900-
"parse5-htmlparser2-tree-adapter@npm:^7.0.0":
13950+
"parse5-htmlparser2-tree-adapter@npm:^7.0.0, parse5-htmlparser2-tree-adapter@npm:^7.1.0":
1390113951
version: 7.1.0
1390213952
resolution: "parse5-htmlparser2-tree-adapter@npm:7.1.0"
1390313953
dependencies:
@@ -13907,7 +13957,16 @@ __metadata:
1390713957
languageName: node
1390813958
linkType: hard
1390913959

13910-
"parse5@npm:^7.0.0":
13960+
"parse5-parser-stream@npm:^7.1.2":
13961+
version: 7.1.2
13962+
resolution: "parse5-parser-stream@npm:7.1.2"
13963+
dependencies:
13964+
parse5: "npm:^7.0.0"
13965+
checksum: 10c0/e236c61000d38ecad369e725a48506b051cebad8abb00e6d4e8bff7aa85c183820fcb45db1559cc90955bdbbdbd665ea94c41259594e74566fff411478dc7fcb
13966+
languageName: node
13967+
linkType: hard
13968+
13969+
"parse5@npm:^7.0.0, parse5@npm:^7.3.0":
1391113970
version: 7.3.0
1391213971
resolution: "parse5@npm:7.3.0"
1391313972
dependencies:
@@ -17364,6 +17423,13 @@ __metadata:
1736417423
languageName: node
1736517424
linkType: hard
1736617425

17426+
"undici@npm:^7.19.0":
17427+
version: 7.20.0
17428+
resolution: "undici@npm:7.20.0"
17429+
checksum: 10c0/99054958a07b4105e1461bf5f38550746a15e01d6807e7a2b0849f18e1bc3f481c1ad080ea87b255a39264cec5d80ebf2b3bc82c3e732d81e6a0cc3c920c05c6
17430+
languageName: node
17431+
linkType: hard
17432+
1736717433
"unicode-canonical-property-names-ecmascript@npm:^2.0.0":
1736817434
version: 2.0.1
1736917435
resolution: "unicode-canonical-property-names-ecmascript@npm:2.0.1"
@@ -18008,6 +18074,22 @@ __metadata:
1800818074
languageName: node
1800918075
linkType: hard
1801018076

18077+
"whatwg-encoding@npm:^3.1.1":
18078+
version: 3.1.1
18079+
resolution: "whatwg-encoding@npm:3.1.1"
18080+
dependencies:
18081+
iconv-lite: "npm:0.6.3"
18082+
checksum: 10c0/273b5f441c2f7fda3368a496c3009edbaa5e43b71b09728f90425e7f487e5cef9eb2b846a31bd760dd8077739c26faf6b5ca43a5f24033172b003b72cf61a93e
18083+
languageName: node
18084+
linkType: hard
18085+
18086+
"whatwg-mimetype@npm:^4.0.0":
18087+
version: 4.0.0
18088+
resolution: "whatwg-mimetype@npm:4.0.0"
18089+
checksum: 10c0/a773cdc8126b514d790bdae7052e8bf242970cebd84af62fb2f35a33411e78e981f6c0ab9ed1fe6ec5071b09d5340ac9178e05b52d35a9c4bcf558ba1b1551df
18090+
languageName: node
18091+
linkType: hard
18092+
1801118093
"which-boxed-primitive@npm:^1.1.0, which-boxed-primitive@npm:^1.1.1":
1801218094
version: 1.1.1
1801318095
resolution: "which-boxed-primitive@npm:1.1.1"

0 commit comments

Comments
 (0)