UNPKG

@gobstones/typedoc-theme-gobstones

Version:

A simple theme for the Gobstones generated documentation.

26 lines 976 B
/** * The main module of the theme. * * @remarks * To define a theme in TypeDoc, the main module need's to export only * a `load` function. This is the module that exports such function. * * Additionally, this module provides the default options used by the theme. * Note that not all the configuration can be provided by the theme, and * some minimal configuration should be provided through the typedoc * configuration file. * * @module Main * @author Alan Rodas Bonjour <alanrodas@gmail.com> */ import { Application } from 'typedoc'; /** * The **load** function is called by TypeDoc when loading the theme * (as a plugin). This function performs all side-loads * and uses the received `app` to define a new theme, * with a given name and associated with a particular theme class. * * @param typedocApp - The instance of the running TypeDoc application */ export declare const load: (typedocApp: Application) => void; //# sourceMappingURL=index.d.ts.map