myst-to-jats
Version:
Export from MyST Markdown to JATS
16 lines • 800 B
TypeScript
import type { Plugin } from 'unified';
import type { Parent } from 'myst-spec';
import type { GenericParent } from 'myst-common';
export type DefinitionItem = Parent & {
type: 'definitionItem';
};
/**
* This transforms a flat list of alternating dt/dd into a definitionItem for each term.
* - `defList -> [defTerm, defDescription, defDescription, defTerm, defDescription]`
* - `defList -> [defItem -> [defTerm, defDescription, defDescription], defItem -> [defTerm, defDescription]]`
*
* It will also ensure that any nested defDescriptions that are not paragraphs are wrapped in paragraphs.
*/
export declare function definitionTransform(mdast: GenericParent): void;
export declare const definitionPlugin: Plugin<[], GenericParent, GenericParent>;
//# sourceMappingURL=definitions.d.ts.map