plugin documentation need

[rookiefront]

Search terms

Whether a complete plug-in development documentation is available

Question

import typedoc from 'typedoc'
import  {MyPlugin} from './typedoc-plugin-a1.js'
/**
 * 生成 typedoc 文档
 * @constructor
 */
export async function GenerateTypeDoc() {
  const app = new typedoc.Application()

  app.options.addReader(new typedoc.TSConfigReader())

  // app.renderer.
  app.renderer.addComponent("typedoc-plugin-a1",new MyPlugin(app.renderer))
  app.options.addReader(new typedoc.TypeDocReader())
  app.bootstrap({
    entryPoints: ['packages/utils/index.ts'],
    // 设置自定义的主题
    plugin: [
      'typedoc-plugin-a1'
    ]
  })

  const project = app.convert()
  if (project) {
    const outputDir = "doc/utils"
    // 生成文档
    await app.generateDocs(project, outputDir)
    // 生成json
    await app.generateJson(project, outputDir + "/documentation.json")
  }
}
GenerateTypeDoc()

import { Component, RendererComponent } from 'typedoc/dist/lib/output/components';

export  class MyPlugin extends RendererComponent {
  initialize() {
    console.log('MyPlugin: Initialized');
    super.initialize();
  }

  render() {
    console.log('MyPlugin: Rendered');
  }
}

I think I need a complete document,

[Gerrit0]

There is not much documentation available, #521 tracks that task.

https://typedoc.org/guides/development/ has some info, I recommend looking at the source of plugins listed at https://typedoc.org/guides/plugins/ for examples.