typedoc-plugin-markdown/dist/theme/lib/get-anchored-title.d.ts

A TypeDoc plugin that generates TypeScript API documentation as Markdown.

import type { MarkdownThemeContext } from '../../theme/index.js';
/**
 * Applies the anchor options to a heading title:
 *
 * - `useHTMLAnchors`: returns an `<a id>` tag to place before the heading.
 * - `useCustomAnchors`: appends the anchor to the title in the configured
 *   `customAnchorsFormat`.
 *
 * Without an anchor the title is returned unchanged.
 */
export declare function getAnchoredTitle(context: MarkdownThemeContext, title: string, anchor: string | undefined): {
    htmlAnchor?: string;
    title: string;
};