index.d.ts

import type { MarkedExtension } from 'marked';

export interface MarkedGithubFootnoteOptions {
  /** Prepended to every generated id. Use `"user-content-"` to reproduce GitHub's ids verbatim. Default: `""`. */
  prefixId?: string;
  /** Text of the visually hidden footnotes section heading. Default: `"Footnotes"`. */
  heading?: string;
  /** aria-label template for back-reference links. Use `{0}` for the reference number, `{1}` for the suffix (e.g. "-2"). Default: `"Back to reference {0}{1}"`. */
  backRefLabel?: string;
}

export function markedGithubFootnote(options?: MarkedGithubFootnoteOptions): MarkedExtension;