milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
71 stars 26 forks source link

feat: including more than just readme #68

Closed gabrielcsapo closed 2 years ago

gabrielcsapo commented 2 years ago

We have multiple packages that have their own docs, is this something that the plugin could handle including as a result of configuring API generation for these packages?

[
    'docusaurus-plugin-typedoc-api',
    {
      projectRoot: path.join(__dirname, '..', '..', '..'),
      packages: [{
        path: 'packages/foo',
        entry: 'addon/'
        includeMarkdown: ['docs/*.md']
      }]
    }
  ]
milesj commented 2 years ago

My initial reaction is that these should simply be in docs/. I don't want to rebuild everything that the docs plugin is doing.

gabrielcsapo commented 2 years ago

Yeah but in this case the API docs and docs are going to be In two different places rather than right next to each other. Is there a nice way to ensure both exist in the same place?

milesj commented 2 years ago

I don't see an issue with that. This is for generating API docs, not normal docs, and expecting them to be colocated goes against the purpose of this plugin.

gabrielcsapo commented 2 years ago

Makes sense, will close this.