search

milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
69 stars 25 forks source link

`VersionBanner` "cannot read properties of undefined" #124

Open audionerd opened 9 months ago

audionerd commented 9 months ago

I have the plugin configured for our project, but I'm getting this error from VersionBanner when I try to render any documentation page:

VersionBanner-bug

In our configuration, the latest and current docs are both at v5, whereas some Markdown docs are at v4. The API docs are per-package, with multiple packages, and none of them really need to be versioned (always showing API docs for only the latest version is probably fine).

The problem is this line: https://github.com/milesj/docusaurus-plugin-typedoc-api/blob/9169c0e9ab804e6cac5f915665e0efd041ab46f0/packages/plugin/src/components/VersionBanner.tsx#L20

Where latestVersion is

{name: 'current', label: 'XState v5', isLast: true, path: '/docs', mainDocId: 'about', …}

And docs is:

{
  4: {id: '/api', title: '4', description: '4'}
}

So docs['XState v5'] does not exist.

I'm using patch-package to bypass VersionBanner for now. Wondering if there's a simple fix for this I'm overlooking?

Project is here: https://github.com/statelyai/docs/pull/288