site/node_modules/rehype-slug/lib/index.d.ts

20 lines
443 B
TypeScript
Raw Normal View History

2024-10-14 06:09:33 +00:00
/**
* Add `id`s to headings.
*
* @param {Options | null | undefined} [options]
* Configuration (optional).
* @returns
* Transform.
*/
export default function rehypeSlug(options?: Options | null | undefined): (tree: Root) => undefined;
export type Root = import('hast').Root;
/**
* Configuration (optional).
*/
export type Options = {
/**
* Prefix to add in front of `id`s (default: `''`).
*/
prefix?: string;
};