48 lines
1.8 KiB
TypeScript
48 lines
1.8 KiB
TypeScript
/**
|
|
* Create an extension for `mdast-util-to-markdown` to enable GFM tables in
|
|
* markdown.
|
|
*
|
|
* @param {Options | null | undefined} [options]
|
|
* Configuration.
|
|
* @returns {ToMarkdownExtension}
|
|
* Extension for `mdast-util-to-markdown` to enable GFM tables.
|
|
*/
|
|
export function gfmTableToMarkdown(
|
|
options?: Options | null | undefined
|
|
): ToMarkdownExtension
|
|
/**
|
|
* Extension for `mdast-util-from-markdown` to enable GFM tables.
|
|
*
|
|
* @type {FromMarkdownExtension}
|
|
*/
|
|
export const gfmTableFromMarkdown: FromMarkdownExtension
|
|
export type Table = import('mdast').Table
|
|
export type TableRow = import('mdast').TableRow
|
|
export type TableCell = import('mdast').TableCell
|
|
export type InlineCode = import('mdast').InlineCode
|
|
export type MarkdownTableOptions = import('markdown-table').MarkdownTableOptions
|
|
export type CompileContext = import('mdast-util-from-markdown').CompileContext
|
|
export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension
|
|
export type FromMarkdownHandle = import('mdast-util-from-markdown').Handle
|
|
export type ToMarkdownExtension = import('mdast-util-to-markdown').Options
|
|
export type ToMarkdownHandle = import('mdast-util-to-markdown').Handle
|
|
export type ToMarkdownContext = import('mdast-util-to-markdown').Context
|
|
export type SafeOptions = import('mdast-util-to-markdown').SafeOptions
|
|
/**
|
|
* Configuration.
|
|
*/
|
|
export type Options = {
|
|
/**
|
|
* Whether to add a space of padding between delimiters and cells.
|
|
*/
|
|
tableCellPadding?: boolean | null | undefined
|
|
/**
|
|
* Whether to align the delimiters.
|
|
*/
|
|
tablePipeAlign?: boolean | null | undefined
|
|
/**
|
|
* Function to detect the length of table cell content, used when aligning
|
|
* the delimiters between cells
|
|
*/
|
|
stringLength?: MarkdownTableOptions['stringLength'] | null | undefined
|
|
}
|