@gobstones/typedoc-theme-gobstones
Version:
A simple theme for the Gobstones generated documentation.
22 lines • 888 B
TypeScript
/**
* @module Theme/Templates
* @author Alan Rodas Bonjour <alanrodas@gmail.com>
*/
import { JSX } from 'typedoc';
import type { DeclarationReflection, DefaultThemeRenderContext, PageEvent, ProjectReflection } from 'typedoc';
/**
* Get the roots of the given project reflection.
*/
export declare const getHierarchyRoots: (project: ProjectReflection) => DeclarationReflection[];
/**
* The component that defines how to render an element's hierarchy.
* The page that displays the hierarchy of an element as main content
* uses this template.
*
* @param context - The theme context.
* @param props - A page event with the project's reflection.
*
* @returns A JSX.Element to render the hierarchy.
*/
export declare const hierarchyTemplate: (context: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;
//# sourceMappingURL=hierarchyTemplate.d.ts.map