site/node_modules/micromark-extension-gfm/index.d.ts

29 lines
1.1 KiB
TypeScript
Raw Normal View History

2024-10-14 06:09:33 +00:00
/**
* Create an extension for `micromark` to enable GFM syntax.
*
* @param {Options | null | undefined} [options]
* Configuration (optional).
*
* Passed to `micromark-extens-gfm-strikethrough`.
* @returns {Extension}
* Extension for `micromark` that can be passed in `extensions` to enable GFM
* syntax.
*/
export function gfm(options?: Options | null | undefined): Extension
/**
* Create an extension for `micromark` to support GFM when serializing to HTML.
*
* @param {HtmlOptions | null | undefined} [options]
* Configuration (optional).
*
* Passed to `micromark-extens-gfm-footnote`.
* @returns {HtmlExtension}
* Extension for `micromark` that can be passed in `htmlExtensions` to
* support GFM when serializing to HTML.
*/
export function gfmHtml(options?: HtmlOptions | null | undefined): HtmlExtension
export type HtmlOptions = import('micromark-extension-gfm-footnote').HtmlOptions
export type Options = import('micromark-extension-gfm-strikethrough').Options
export type Extension = import('micromark-util-types').Extension
export type HtmlExtension = import('micromark-util-types').HtmlExtension