@pretextbook/remark-pretext 0.1.0 → 0.3.0

package/dist/lib/context.d.ts

@@ -11,6 +11,8 @@ export interface VisitContext {
     messages?: ConversionMessage[];
     /** Raw source markdown (optional, used for delimiter detection). */
     source?: string;
+    /** Turns a slice of `source` back into what the author wrote. */
+    restoreSource: (text: string) => string;
     /** The division type that a depth-1 heading (`#`) maps to. */
     topLevelDivision: TopLevelDivisionType;
     /** When set, the whole document is wrapped in this root element

package/dist/lib/heading-attributes.d.ts

@@ -0,0 +1,8 @@
+import { Root } from 'mdast';
+/** What a heading keeps in `data`, once its attributes are read. */
+export interface HeadingAttributes {
+    id?: string;
+    attributes?: Record<string, string>;
+}
+/** Move any trailing attributes out of each heading's text and into `data`. */
+export declare function applyHeadingAttributes(tree: Root, source?: string): void;

package/dist/lib/math-parser.d.ts

@@ -10,9 +10,13 @@ declare module "mdast" {
         math: Math;
     }
 }
+/** A math node standing in for a token, plus the source it replaced. */
+export interface MathToken extends Math {
+    source: string;
+}
 export interface MathTokenizationResult {
     markdown: string;
-    tokens: Map<string, Math>;
+    tokens: Map<string, MathToken>;
 }
 export declare function tokenizeMathInMarkdown(markdown: string): MathTokenizationResult;
 /**
@@ -26,6 +30,8 @@ export declare function splitTextWithMath(text: string): (Text | Math)[];
  * Remark plugin that detects and parses math delimiters in text nodes.
  */
 export declare function applyMathDelimiters(tree: Root): void;
-export declare function applyMathTokens(tree: Root, tokens: Map<string, Math>): void;
+/** Put back the source of any tokens in `text`. */
+export declare function restoreMathTokens(text: string, tokens: Map<string, MathToken>): string;
+export declare function applyMathTokens(tree: Root, tokens: Map<string, MathToken>): void;
 declare const remarkMath: Plugin<[], Root>;
 export default remarkMath;

package/dist/lib/mdast-to-ptxast.d.ts

@@ -19,10 +19,13 @@ export interface MdastToPtxastOptions {
      * root-level division built from the document, e.g. from frontmatter. */
     topLevelAttributes?: Record<string, string>;
     /** Title of the document's top-level division (or document root), e.g.
-     * from frontmatter `title`. When set for a non-root document, a depth-1
-     * heading (`#`) no longer supplies that title — it starts the first
-     * subdivision instead. */
+     * from frontmatter `title`, written as inline markdown. When set for a
+     * non-root document, a depth-1 heading (`#`) no longer supplies that title —
+     * it starts the first subdivision instead. */
     topLevelTitle?: string;
+    /** Turns a slice of `source` back into what the author wrote, if `source`
+     * isn't already that (math is tokenized before parsing). */
+    restoreSource?: (text: string) => string;
 }
 /** Transform an mdast Root node into an xast Root node (backwards compatible). */
 export declare function mdastToPtxast(tree: MdastRoot, source?: string, options?: MdastToPtxastOptions): Root;

package/dist/lib/parse-markdown.d.ts

@@ -0,0 +1,16 @@
+import { PhrasingContent, Root } from 'mdast';
+export interface ParsedMarkdown<T> {
+    tree: T;
+    /** The text that was parsed, which node positions are offsets into. */
+    source: string;
+    /** Turns a slice of `source` back into what the author wrote. */
+    restoreSource: (text: string) => string;
+}
+/** Parse a markdown document, directives included. */
+export declare function parseMarkdown(markdown: string): ParsedMarkdown<Root>;
+/**
+ * Parse a string that can only be inline content, such as a title from
+ * frontmatter: `1. Intro` is a title, not a list, and `Groups:Rings` has no
+ * directive in it.
+ */
+export declare function parseInlineMarkdown(markdown: string): ParsedMarkdown<PhrasingContent[]>;

package/dist/lib/raw-pretext.d.ts

@@ -0,0 +1,28 @@
+import { Root } from 'mdast';
+import { Element, ElementContent } from 'xast';
+/** A block of raw PreTeXt, standing in the mdast tree in place of `html` nodes. */
+export interface RawBlock {
+    type: "ptxRaw";
+    element: Element;
+}
+/** Elements whose content is LaTeX or code, which Markdown must not touch. */
+export declare const VERBATIM_ELEMENTS: Set<string>;
+/** The nodes in a fragment of XML, or null if it isn't well-formed PreTeXt. */
+export declare function parseRawXml(xml: string): ElementContent[] | null;
+/** A raw inline tag: the nodes it stands for, plus the element it opens if any. */
+export interface RawInlineTag {
+    children: ElementContent[];
+    opens?: Element;
+}
+export declare function parseRawInlineTag(value: string): RawInlineTag | null;
+/**
+ * The index of the tag in `nodes` closing the element opened at `start`, or -1.
+ */
+export declare function findClosingTag(nodes: {
+    type: string;
+}[], start: number, name: string): number;
+/**
+ * Replace the raw blocks in `tree` with {@link RawBlock} nodes. This has to run
+ * before sections are built, since a block can span what look like headings.
+ */
+export declare function collectRawBlocks(tree: Root, source: string | undefined, restoreSource: (text: string) => string): void;

package/dist/lib/remark-pretext.d.ts

@@ -25,10 +25,10 @@ export interface RemarkPretextOptions {
     topLevelAttributes?: Record<string, string>;
     /**
      * Title of the document's top-level division (or, when `documentRoot` is
-     * set, the root's own title). Overrides any `title:` field declared in the
-     * markdown's frontmatter. When set for a non-root document, a depth-1
-     * heading (`#`) no longer supplies that title — it starts the first
-     * subdivision instead.
+     * set, the root's own title), written as inline markdown. Overrides any
+     * `title:` field declared in the markdown's frontmatter. When set for a
+     * non-root document, a depth-1 heading (`#`) no longer supplies that title —
+     * it starts the first subdivision instead.
      */
     topLevelTitle?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/remark-pretext",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "remark plugin to transform markdown-style PreTeXt directives into ptxast",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -46,6 +46,7 @@
     "remark-parse": "^11.0.0",
     "unified": "^11.0.0",
     "unist-util-visit": "^5.0.0",
+    "xast-util-from-xml": "^4.0.0",
     "xast-util-to-xml": "^4.0.0"
   },
   "publishConfig": {