[lexical-website] Chore: Update docusaurus-plugin-typedoc#7766
[lexical-website] Chore: Update docusaurus-plugin-typedoc#7766etrepum merged 19 commits intofacebook:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| * @param node LexicalNode. | ||
| * @returns An array (tuple) containing the found Lexical node and the depth difference, or null, if this node doesn't exist. | ||
| */ | ||
| export function $getAdjacentSiblingOrParentSiblingCaret< |
There was a problem hiding this comment.
This was already defined separately in lexical so re-exporting for compatibility
| ); | ||
| } | ||
|
|
||
| class LegacyRouter extends ModuleRouter { |
There was a problem hiding this comment.
The paths all changed in this version of typedoc so this is a custom router that uses a URL scheme that's backwards compatible with ours
| app.renderer.defineRouter('legacy', LegacyRouter); | ||
| app.converter.on( | ||
| Converter.EVENT_CREATE_DECLARATION, | ||
| function removeLicenseComment(ctx, reflection) { |
There was a problem hiding this comment.
This avoids attaching the license to the first definition in the module if it doesn't have its own comment
| configureWebpack(_config, _isServer) { | ||
| return { | ||
| optimization: { | ||
| concatenateModules: false, |
There was a problem hiding this comment.
This is a performance improvement for the build, but may produce more js (~3%) for the clients to download facebook/docusaurus#11199
|
@zurfyx I think something in the admin side of the repo needs to be flipped so this can land, it appears to be looking for statuses of specific checks with the old matrix node-versions |
Description
Updates the API documentation build to use the latest docusaurus-plugin-typedoc and typedoc-plugin-markdown.
Was a lot harder than I expected to track down all of the changes we'd need to make this work similarly to the current version.
The biggest change is that now all of the classes and interfaces are documented in the module they are exported from, there is no longer a separate file for each class and interface or a global index of all classes and all interfaces. In order to get the URLs to be the same I had to write some extra plugins.
Before: https://lexical.dev/docs/api/
After: https://lexical-git-fork-etrepum-update-docusaurus-fbopensource.vercel.app/docs/api/
Other relevant changes:
Closes #6072
Test plan
There aren't tests for the documentation, but the build process does throw errors if there are broken links.