@pretextbook/ptxast-util-to-mdast

Convert ptxast (PreTeXt AST) to mdast (Markdown AST) and Markdown strings. Part of the pretext-tools unified.js ecosystem.

Install

npm install @pretextbook/ptxast-util-to-mdast

Use

import { ptxastToMdast, ptxastToMarkdown } from '@pretextbook/ptxast-util-to-mdast';

// Convert a ptxast root to mdast
const mdast = ptxastToMdast(ptxRoot);

// Or convert directly to a markdown string
const markdown = ptxastToMarkdown(ptxRoot);

API

ptxastToMdast(root: PtxRoot): Root

Converts a PtxRoot tree to an mdast Root tree with directive nodes for PreTeXt block environments.

ptxastToMarkdown(root: PtxRoot): string

Converts a PtxRoot tree to a Markdown string. Theorem-like environments render as :::theorem directive fences; divisions render as ATX headings, relative to the document's actual outermost division (a depth-1 heading is whatever that division is — chapter, section, part, ...).

When the outermost division isn't chapter (the default a depth-1 heading is assumed to mean by @pretextbook/remark-pretext), a division: frontmatter block is prepended so the markdown can be converted back to PreTeXt unambiguously:

---
division: section
---

# Top-level section

## A subsection

License

GPL-3.0-or-later