@gobstones/typedoc-theme-gobstones
Version:
A simple theme for the Gobstones generated documentation.
42 lines • 1.4 kB
TypeScript
/**
* @module Utils
* @author Alan Rodas Bonjour <alanrodas@gmail.com>
*/
import { Application } from 'typedoc';
/**
* A class that wraps the idea of a `Plugin` for TypeDoc.
*
* @remarks
* Similarly to themes, this class is structured so that
* subclasses can access the main TypeDoc app through
* the `this.application` property.
*
* Subclasses are expected to overwrite this class and to
* define an `initialize` method, which is just a fancy name
* for the `load` function that is exported by regular plugins.
*/
export declare abstract class TypedocPlugin {
application: Application;
/**
* Create a new instance of this plugin.
*
* @param application - The instance of the running TypeDoc application
*/
constructor(application: Application);
/**
* Initialize the plugin, loading all required configuration for it.
*
* @remarks
* This function is called when the plugin is loaded, after instantiation
* by the {@link loadPlugin} function.
*/
abstract initialize(): void | Promise<void>;
}
/**
* Load a plugin into the application.
*
* @param typedocApp - The instance of the running TypeDoc application
* @param plugin - The class of the plugin to load.
*/
export declare const loadPlugin: (typedocApp: Application, plugin: new (app: Application) => TypedocPlugin) => void;
//# sourceMappingURL=Plugins.d.ts.map