Options
All
  • Public
  • Public/Protected
  • All
Menu

@mavenomics/help

Index

Modules

Classes

Interfaces

Variables

Functions

Object literals

Variables

Const IHelpDocProvider

IHelpDocProvider: Token<IHelpDocProvider> = new Token<IHelpDocProvider>("MavenWorks Help Document Provider")

Functions

openAbout

  • openAbout(): Promise<void>

Object literals

Const browserPlugin

browserPlugin: object

autoStart

autoStart: true = true

id

id: string = "@mavenomics/help:browser-plugin"

requires

requires: Token<IHelpDocProvider>[] = [IHelpDocProvider, IPartFactory]

activate

  • activate(app: Application<any>, doc: IHelpDocProvider, factory: IPartFactory): void

Const docProviderPlugin

docProviderPlugin: object

autoStart

autoStart: true = true

id

id: string = "mavenworks:help-doc-provider"

optional

optional: Token<ILatexTypesetter>[] = [ILatexTypesetter,IRenderMimeRegistry]

provides

provides: Token<IHelpDocProvider> = IHelpDocProvider

activate

  • activate(_app: unknown, typesetter?: ILatexTypesetter, rendermime?: IRenderMimeRegistry): Promise<DefaultHelpDocProvider>

Const helpPartsPlugin

helpPartsPlugin: object

autoStart

autoStart: true = true

id

id: string = "mavenworks-help-parts-browser-plugin"

requires

requires: Token<IHelpDocProvider>[] = [IHelpDocProvider, IPartFactory]

activate

  • activate(_app: Application<any>, doc: IHelpDocProvider, factory: IPartFactory): Promise<void>

Const layoutPlugin

layoutPlugin: object

autoStart

autoStart: true = true

id

id: string = "mavenworks-help-generator-layout"

requires

requires: Token<IHelpDocProvider>[] = [IHelpDocProvider]

activate

Generated using TypeDoc