Skip to content

Commit a014deb

Browse files
authored
docs: link external symbols from the docs (#530)
Links several interfaces / classes from Crawlee and `apify-client` in the API reference. Recent updates to `@apify/docusaurus-typedoc-api-plugin` allow rendering those as links in the built HTML. The enumeration is not exhaustive, it's very possible I missed some interfaces / types. Closes #283
1 parent de31e47 commit a014deb

File tree

3 files changed

+48
-46
lines changed

3 files changed

+48
-46
lines changed

website/docusaurus.config.js

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,46 @@ module.exports = {
138138
})),
139139
typedocOptions: {
140140
excludeExternals: false,
141+
externalSymbolLinkMappings: {
142+
'@crawlee/core': {
143+
Configuration:
144+
'https://crawlee.dev/js/api/core/class/Configuration',
145+
Dataset:
146+
'https://crawlee.dev/js/api/core/class/Dataset',
147+
DatasetExportOptions:
148+
'https://crawlee.dev/js/api/core/interface/DatasetExportOptions',
149+
DatasetExportToOptions:
150+
'https://crawlee.dev/js/api/core/interface/DatasetExportToOptions',
151+
EventManager:
152+
'https://crawlee.dev/js/api/core/class/EventManager',
153+
KeyValueStore:
154+
'https://crawlee.dev/js/api/core/class/KeyValueStore',
155+
StorageManagerOptions:
156+
'https://crawlee.dev/js/api/core/interface/StorageManagerOptions',
157+
ConfigurationOptions:
158+
'https://crawlee.dev/js/api/core/interface/ConfigurationOptions',
159+
EventManager:
160+
'https://crawlee.dev/js/api/core/interface/EventManager',
161+
RecordOptions:
162+
'https://crawlee.dev/js/api/core/interface/RecordOptions',
163+
UseStateOptions:
164+
'https://crawlee.dev/js/api/core/interface/UseStateOptions',
165+
},
166+
'apify-client': {
167+
ActorCallOptions:
168+
'https://docs.apify.com/api/client/js/reference/interface/ActorCallOptions',
169+
ActorStartOptions:
170+
'https://docs.apify.com/api/client/js/reference/interface/ActorStartOptions',
171+
ApifyClientOptions:
172+
'https://docs.apify.com/api/client/js/reference/interface/ApifyClientOptions',
173+
RunAbortOptions:
174+
'https://docs.apify.com/api/client/js/reference/interface/RunAbortOptions',
175+
TaskCallOptions:
176+
'https://docs.apify.com/api/client/js/reference/interface/TaskCallOptions',
177+
Webhook:
178+
'https://docs.apify.com/api/client/js/reference/interface/Webhook',
179+
},
180+
},
141181
},
142182
routeBasePath: 'reference',
143183
},

website/package-lock.json

Lines changed: 7 additions & 45 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)