Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup for monorepo but only one package API #84

Closed
csantos1113 opened this issue Dec 9, 2022 · 1 comment
Closed

setup for monorepo but only one package API #84

csantos1113 opened this issue Dec 9, 2022 · 1 comment

Comments

@csantos1113
Copy link

Hey all, thanks for this plugin, the output is really nice.

I have a monorepo where the majority of the packages are "non-public", or non-typescript, or what not, not relevant I'd say.

The thing is that there is only one package I care about the API documentation, so I would like to do something like:

const __dirname = dirname(url.fileURLToPath(import.meta.url));
const projectRoot = join(__dirname, '..');

[
  'docusaurus-plugin-typedoc-api',
  {
    projectRoot,
    packages: ['packages/web'],
    changelogs: false,
    readmes: true,
    gitRefName: 'main',
    typedocOptions: {
      plugin: ['typedoc-plugin-missing-exports']
    }
  }
],

But, the API pages are not generated at all.

I can see api-typedoc-default.json with the full information of my package, but whatever docusaurus-plugin-typedoc-api does, is completely ignoring the results.

I took a look at the internal of this plugin and found this:

const isSinglePackage = packageConfigs.length === 1;

Question

Is there a way to make this plugin work for one package within a monorepo?

@milesj
Copy link
Owner

milesj commented Dec 14, 2022

Fixed here: #85

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants