index.d.ts 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. /**
  2. * Create an extension for `mdast-util-from-markdown`.
  3. *
  4. * @returns {FromMarkdownExtension}
  5. * Extension for `mdast-util-from-markdown`.
  6. */
  7. export function mathFromMarkdown(): FromMarkdownExtension;
  8. /**
  9. * Create an extension for `mdast-util-to-markdown`.
  10. *
  11. * @param {ToOptions | null | undefined} [options]
  12. * Configuration (optional).
  13. * @returns {ToMarkdownExtension}
  14. * Extension for `mdast-util-to-markdown`.
  15. */
  16. export function mathToMarkdown(options?: ToOptions | null | undefined): ToMarkdownExtension;
  17. export type HastElement = import('hast').Element;
  18. export type HastElementContent = import('hast').ElementContent;
  19. export type CompileContext = import('mdast-util-from-markdown').CompileContext;
  20. export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension;
  21. export type FromMarkdownHandle = import('mdast-util-from-markdown').Handle;
  22. export type ToMarkdownHandle = import('mdast-util-to-markdown').Handle;
  23. export type ToMarkdownExtension = import('mdast-util-to-markdown').Options;
  24. export type InlineMath = import('../index.js').InlineMath;
  25. export type Math = import('../index.js').Math;
  26. /**
  27. * Configuration.
  28. */
  29. export type ToOptions = {
  30. /**
  31. * Whether to support math (text) with a single dollar (default: `true`).
  32. *
  33. * Single dollars work in Pandoc and many other places, but often interfere
  34. * with “normal” dollars in text.
  35. * If you turn this off, you can still use two or more dollars for text math.
  36. */
  37. singleDollarTextMath?: boolean | null | undefined;
  38. };