protsl-doc

Appearance

IPluginManifest Interface ​

The manifest for an API Documenter plugin.

Type ​

typescript
export interface IPluginManifest
export interface IPluginManifest

Details ​

An API documenter plugin is an NPM package. By convention, the NPM package name should have the prefix doc-plugin-. Its main entry point should export an object named protslDocPluginManifest which implements the IPluginManifest interface.

Examples ​

ts
class MyMarkdownDocumenter extends MarkdownDocumenterFeature {
  public onInitialized(): void {
    console.log('MyMarkdownDocumenter: onInitialized()');
  }
}

export const protslDocPluginManifest: IPluginManifest = {
  manifestVersion: 1000,
  features: [
    {
      featureName: 'my-markdown-documenter',
      kind: 'MarkdownDocumenterFeature',
      subclass: MyMarkdownDocumenter,
    },
  ],
};
class MyMarkdownDocumenter extends MarkdownDocumenterFeature {
  public onInitialized(): void {
    console.log('MyMarkdownDocumenter: onInitialized()');
  }
}

export const protslDocPluginManifest: IPluginManifest = {
  manifestVersion: 1000,
  features: [
    {
      featureName: 'my-markdown-documenter',
      kind: 'MarkdownDocumenterFeature',
      subclass: MyMarkdownDocumenter,
    },
  ],
};

Properties ​