site/node_modules/micromark-extension-frontmatter/lib/html.d.ts
2024-10-14 08:09:33 +02:00

22 lines
869 B
TypeScript

/**
* Create an extension for `micromark` to support frontmatter when serializing
* to HTML.
*
* > 👉 **Note**: this makes sure nothing is generated in the output HTML for
* > frontmatter.
*
* @param {Options | null | undefined} [options='yaml']
* Configuration (default: `'yaml'`).
* @returns {HtmlExtension}
* Extension for `micromark` that can be passed in `htmlExtensions`, to
* support frontmatter when serializing to HTML.
*/
export function frontmatterHtml(
options?: Options | null | undefined
): HtmlExtension
export type CompileContext = import('micromark-util-types').CompileContext
export type Handle = import('micromark-util-types').Handle
export type HtmlExtension = import('micromark-util-types').HtmlExtension
export type TokenType = import('micromark-util-types').TokenType
export type Options = import('./to-matters.js').Options