@pretextbook/remark-pretext 0.0.9 → 0.0.11

package/dist/lib/context.d.ts

@@ -25,6 +25,16 @@ export interface VisitContext {
     topLevelAttributesApplied?: {
         done: boolean;
     };
+    /** The title of the document's top-level division (or document root), e.g.
+     * from frontmatter `title`. When set for a non-root document, depth-1
+     * headings no longer supply the top-level title — they start the first
+     * subdivision instead (see `headingDepthOffset`). */
+    topLevelTitle?: string;
+    /** Added to a heading's raw depth when resolving its division type. Set to
+     * `1` when `topLevelTitle` supplies the top-level division's title itself,
+     * so a depth-1 heading (`#`) resolves one level deeper (the first
+     * subdivision) instead of the top-level division. */
+    headingDepthOffset?: number;
 }
 export interface ConversionMessage {
     type: 'warning' | 'error';

package/dist/lib/frontmatter.d.ts

@@ -8,6 +8,9 @@ export interface FrontmatterResult {
     documentRoot?: RootDivisionType;
     /** Attributes (`xml:id`, `label`, `component`) for the top-level division. */
     attributes?: Record<string, string>;
+    /** The title of the document's top-level division (or document root),
+     * when a `title:` field is present. */
+    title?: string;
     /** The markdown source with the frontmatter block removed. */
     body: string;
 }

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

@@ -18,6 +18,11 @@ export interface MdastToPtxastOptions {
     /** Attributes (`xml:id`, `label`, `component`) applied to the first
      * 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. */
+    topLevelTitle?: 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/remark-pretext.d.ts

@@ -23,6 +23,14 @@ export interface RemarkPretextOptions {
      * fields declared in the markdown's frontmatter.
      */
     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.
+     */
+    topLevelTitle?: string;
 }
 declare const remarkPretext: Plugin<[RemarkPretextOptions?], MdastRoot, Root>;
 export default remarkPretext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pretextbook/remark-pretext",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "remark plugin to transform markdown-style PreTeXt directives into ptxast",
   "author": "Oscar Levin",
   "license": "MIT",
@@ -39,7 +39,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@pretextbook/ptxast": "^0.0.7",
+    "@pretextbook/ptxast": "^0.0.8",
     "@types/mdast": "^4.0.0",
     "mdast-util-directive": "^3.0.0",
     "remark-directive": "^4.0.0",