milesj / docusaurus-plugin-typedoc-api

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

Internal referance to the types/interfaces are not generated #149

Closed imnaiyar closed 1 month ago

imnaiyar commented 1 month ago

image

As you can see, quizOptions is an interface, it only shows it's name but it's definition page is not generated. I'm not sure if it's by design or I have to do something extra for it to work. This happens for all referenced types, the above is just example

I export the type just fine

export interface quizOptions {
  usersData: userData[],
  colors: colorsType
}

Here's my docusaurus.config.js if it matters

// ...other options
plugins: [
    [
      'docusaurus-plugin-typedoc-api',
      {
        projectRoot: join(__dirname, "../"),
        packages: ['.'],
        typedocOptions: {
          tsconfig: '../tsconfig.json',
          includeVersion: true,
          excludePrivate: true,
          excludeExternals: false,
          excludeNotDocumented: false,
        },
      },
    ],
  ],
imnaiyar commented 1 month ago

nvm, just had to reference the types file