fumadocs-core/dist/remark-heading-CXvCY0go.d.ts

The React.js library for building a documentation website

import { Transformer } from "unified";
import { Heading, Root } from "mdast";

//#region src/mdx-plugins/remark-heading.d.ts
declare module 'mdast' {
  interface HeadingData extends Data {
    hProperties?: {
      id?: string;
    };
  }
}
interface RemarkHeadingOptions {
  slug?: (root: Root, heading: Heading, text: string) => string;
  /**
   * Allow custom headings ids
   *
   * @defaultValue true
   */
  customId?: boolean;
  /**
   * Attach an array of `TOCItemType` to `file.data.toc`
   *
   * @defaultValue true
   */
  generateToc?: boolean;
}
/**
 * Add heading ids and extract TOC
 */
declare function remarkHeading({
  slug: defaultSlug,
  customId,
  generateToc
}?: RemarkHeadingOptions): Transformer<Root, Root>;
//#endregion
export { remarkHeading as n, RemarkHeadingOptions as t };
//# sourceMappingURL=remark-heading-CXvCY0go.d.ts.map