@gobstones/typedoc-theme-gobstones/dist/Theme/Layouts/default.d.ts

A simple theme for the Gobstones generated documentation.

import { DefaultThemeRenderContext, JSX, PageEvent, Reflection, RenderTemplate } from 'typedoc';
/**
 * The name to display as the main title of the documentation.
 * Default to the package name followed by a dash and a "v" followd
 * by the version number.
 *
 * @param refl - The main reflection
 *
 * @returns The display name as a string
 */
export declare const getDisplayName: (refl: Reflection) => string;
/**
 * The default layout to use by the theme.
 *
 * @remarks
 * The layout is the main structure of the produced HTML document, including
 * the main tags, such as head and body, as well as loading all the scripts
 * and styles.
 *
 * @privateRemarks
 * Note that there are ways to load a style or script into a theme through code,
 * yet, as we are redefining the template, loading custom elements is done entirely
 * into this file.
 *
 * @param context - The theme's context
 * @param template - The template in use.
 * @param props - The page event with the reflection.
 *
 * @returns The default layout in use as a JSX.Element.
 */
export declare const defaultLayout: (context: DefaultThemeRenderContext, template: RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => JSX.Element;
//# sourceMappingURL=default.d.ts.map