Can't auto-generate docs using the package about docusaurus-plugin-typedoc-api HOT 6 CLOSED

Found the solution. my mistake was following config:

        projectRoot: path.join(__dirname, '..'),
        packages: [
          {
            path: '/',
            entry: {
              index: 'src/index.tsx',
            }
          }
        ],

correct one is:

        projectRoot: path.join(__dirname, '..'),
        packages: [
          {
            path: '.',
            entry: {
              index: 'src/index.tsx',
            }
          }
        ],

so instead of /in path use ..... solved the problem.

from docusaurus-plugin-typedoc-api.

Looks like youre not using workspaces, so you'll need to add typescript to the website itself: https://github.com/SahilAujla/alchemy-sdk/blob/main/website/package.json

from docusaurus-plugin-typedoc-api.

Thank you so much for your response @milesj

I installed typescript in the website and this time it worked and the site started on http://localhost:3000/ but it was just the default site that we get with docusaurs i.e. the docusaurus-plugin-typedoc-api did not auto-generate the docs for SDK.

I've used docusaurus-plugin-typedoc in the past and it automatically generated the docs for the SDK whenever I did yarn start in the website.

Is there anything else I need to do in order to generate the docs with the plugin?

from docusaurus-plugin-typedoc-api.

@SahilAujla Have you configured the /api route? What happens when you go to it?

from docusaurus-plugin-typedoc-api.

@milesj sorry for the late response.

Not sure what you mean by /api route. But I tried creating an api folder inside the website folder, in the hopes that the docs will get auto-generated inside that folder when I run npm run start, but nothing happened.

You can see it here in my Github repo for the project:

https://github.com/SahilAujla/alchemy-sdk/tree/main/website/api

from docusaurus-plugin-typedoc-api.

I also have problem getting this to work. when visiting /api is says "page not found".

the configration in docusaurus.config.js for themeConfig.navbar.items is set to this:

[
          {
            to: 'api',
            label: 'API',
            position: 'left'
          }
]

Any ideas, what could be wrong?

from docusaurus-plugin-typedoc-api.