mystmd 1.1.47__tar.gz → 1.1.48__tar.gz

{mystmd-1.1.47 → mystmd-1.1.48}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: mystmd
-Version: 1.1.47
+Version: 1.1.48
 Summary: Command line tools for MyST Markdown
 Project-URL: Homepage, https://github.com/executablebooks/mystmd
 Project-URL: Bug Tracker, https://github.com/executablebooks/mystmd/issues

{mystmd-1.1.47 → mystmd-1.1.48}/_package.json

@@ -1,6 +1,6 @@
 {
   "name": "mystmd",
-  "version": "1.1.47",
+  "version": "1.1.48",
   "description": "Command line tools for MyST Markdown",
   "author": "Rowan Cockett <rowan@curvenote.com>",
   "license": "MIT",
@@ -45,6 +45,6 @@
     "commander": "^10.0.1",
     "core-js": "^3.31.1",
     "js-yaml": "^4.1.0",
-    "myst-cli": "^1.1.47"
+    "myst-cli": "^1.1.48"
   }
 }

{mystmd-1.1.47 → mystmd-1.1.48}/src/mystmd_py/myst.cjs

@@ -195964,7 +195964,7 @@ var {
 } = import_index.default;
 
 // src/version.ts
-var version = "1.1.47";
+var version = "1.1.48";
 var version_default = version;
 
 // ../myst-cli/dist/build/build.js
@@ -197617,9 +197617,17 @@ var FRONTMATTER_ALIASES = {
   ack: "acknowledgments",
   acknowledgements: "acknowledgments",
   availability: "data_availability",
-  plain_language_summary: "summary",
+  dataAvailability: "data_availability",
+  "data-availability": "data_availability",
   quote: "epigraph",
+  plain_language_summary: "summary",
+  "plain-language-summary": "summary",
+  plainLanguageSummary: "summary",
   lay_summary: "summary",
+  "lay-summary": "summary",
+  keyPoints: "keypoints",
+  key_points: "keypoints",
+  "key-points": "keypoints",
   image: "thumbnail"
 };
 function validateSiteFrontmatterKeys(value, opts) {
@@ -202491,12 +202499,17 @@ function createState(selector, tree) {
 }
 
 // ../myst-common/dist/extractParts.js
-function selectBlockParts(tree, part) {
+function coercePart(part) {
   if (!part) {
     return [];
   }
+  return typeof part === "string" ? [part] : part;
+}
+function selectBlockParts(tree, part) {
+  const parts = coercePart(part);
+  if (parts.length === 0)
+    return [];
   const blockParts = selectAll("block", tree).filter((block5) => {
-    const parts = typeof part === "string" ? [part] : part;
     return parts.map((p5) => {
       var _a6, _b;
       return ((_a6 = block5.data) === null || _a6 === void 0 ? void 0 : _a6.part) === p5 || ((_b = block5.data) === null || _b === void 0 ? void 0 : _b.tags) && Array.isArray(block5.data.tags) && block5.data.tags.includes(p5);
@@ -202504,11 +202517,70 @@ function selectBlockParts(tree, part) {
   });
   return blockParts;
 }
+function createPartBlock(children, part, opts) {
+  var _a6;
+  const block5 = { type: "block", children };
+  if (!(opts === null || opts === void 0 ? void 0 : opts.removePartData)) {
+    (_a6 = block5.data) !== null && _a6 !== void 0 ? _a6 : block5.data = {};
+    block5.data.part = part;
+  }
+  return block5;
+}
+function extractImplicitPart(tree, part, opts) {
+  const parts = coercePart(part);
+  if (parts.length === 0)
+    return;
+  let insideImplicitPart = false;
+  const blockParts = [];
+  let paragraphs = [];
+  tree.children.forEach((child, index4) => {
+    var _a6;
+    if (insideImplicitPart && child.type === "paragraph") {
+      paragraphs.push(copyNode(child));
+      child.type = "__part_delete__";
+    }
+    if (child.type !== "__part_delete__" || index4 === tree.children.length - 1) {
+      insideImplicitPart = false;
+      if (paragraphs.length > 0) {
+        blockParts.push(createPartBlock(paragraphs, parts[0], opts));
+        paragraphs = [];
+        selectAll("__part_heading__", tree).forEach((node3) => {
+          node3.type = "__part_delete__";
+        });
+      }
+    }
+    if (child.type === "block") {
+      if ((_a6 = child.data) === null || _a6 === void 0 ? void 0 : _a6.part)
+        return;
+      if (tree.type !== "root")
+        return;
+      const blockPartsTree = extractImplicitPart(child, parts);
+      if (blockPartsTree)
+        blockParts.push(...blockPartsTree.children);
+    } else if (child.type === "heading" && parts.includes(toText(child).toLowerCase())) {
+      insideImplicitPart = true;
+      child.type = "__part_heading__";
+    }
+  });
+  selectAll("__part_heading__", tree).forEach((node3) => {
+    node3.type = "heading";
+  });
+  if (blockParts.length === 0)
+    return;
+  const partsTree = { type: "root", children: blockParts };
+  remove(tree, "__part_delete__");
+  return partsTree;
+}
 function extractPart(tree, part, opts) {
-  const partStrings = typeof part === "string" ? [part] : part;
+  const partStrings = coercePart(part);
+  if (partStrings.length === 0)
+    return;
   const blockParts = selectBlockParts(tree, part);
-  if (blockParts.length === 0)
-    return void 0;
+  if (blockParts.length === 0) {
+    if (opts === null || opts === void 0 ? void 0 : opts.requireExplicitPart)
+      return;
+    return extractImplicitPart(tree, partStrings);
+  }
   const children = copyNode(blockParts).map((block5) => {
     var _a6;
     (_a6 = block5.data) !== null && _a6 !== void 0 ? _a6 : block5.data = {};
@@ -278577,7 +278649,7 @@ function addAffiliation(node3, state) {
   state.closeParagraph();
   const renderedAffil = state.stack.pop();
   const fmAffil = { id: affilNumber, name: getContentFromRenderedSpan(renderedAffil) };
-  if (!affilNumber) {
+  if (!affilNumber && fm.authors.length > 0) {
     const lastAuthor = fm.authors[fm.authors.length - 1];
     if (!lastAuthor.affiliations)
       lastAuthor.affiliations = [];
@@ -281353,8 +281425,10 @@ var dropdownDirective = {
 // ../myst-directives/dist/embed.js
 var embedDirective = {
   name: "embed",
+  doc: "The embed directive allows you to duplicate content from another part of your project. This can also be done through the figure directive.",
   arg: {
     type: String,
+    doc: "The label of the node that you are embedding.",
     required: true
   },
   options: {
@@ -281959,20 +282033,21 @@ var listTableDirective = {
   }
 };
 
-// ../myst-directives/dist/margin.js
-var marginDirective = {
-  name: "margin",
+// ../myst-directives/dist/aside.js
+var asideDirective = {
+  name: "aside",
+  alias: ["margin", "sidebar"],
   body: {
     type: "myst",
     required: true
   },
   run(data) {
-    return [
-      {
-        type: "margin",
-        children: data.body
-      }
-    ];
+    const aside = {
+      type: "aside",
+      kind: data.name == "aside" || data.name == "margin" ? void 0 : data.name,
+      children: data.body
+    };
+    return [aside];
   }
 };
 
@@ -282193,7 +282268,7 @@ var defaultDirectives = [
   includeDirective,
   tableDirective,
   listTableDirective,
-  marginDirective,
+  asideDirective,
   glossaryDirective,
   mathDirective,
   mdastDirective,
@@ -282604,6 +282679,25 @@ var underlineRole = {
   }
 };
 
+// ../myst-roles/dist/keyboard.js
+var keyboardRole = {
+  name: "keyboard",
+  doc: 'The keyboard role denote textual user input from a keyboard, such as "Ctrl" + "Space".',
+  alias: ["kbd"],
+  body: {
+    type: String,
+    required: true
+  },
+  run(data) {
+    const body3 = data.body;
+    const node3 = {
+      type: "keyboard",
+      children: [{ type: "text", value: body3 }]
+    };
+    return [node3];
+  }
+};
+
 // ../myst-roles/dist/index.js
 var defaultRoles = [
   abbreviationRole,
@@ -282620,7 +282714,8 @@ var defaultRoles = [
   smallcapsRole,
   subscriptRole,
   superscriptRole,
-  underlineRole
+  underlineRole,
+  keyboardRole
 ];
 
 // ../myst-parser/dist/tlds.js
@@ -285403,7 +285498,7 @@ var import_node_path16 = __toESM(require("path"), 1);
 var import_nbtx = __toESM(require_cjs2(), 1);
 
 // ../myst-cli/dist/version.js
-var version2 = "1.1.47";
+var version2 = "1.1.48";
 var version_default2 = version2;
 
 // ../myst-cli/dist/utils/headers.js
@@ -300482,6 +300577,33 @@ function getClasses2(className) {
 }
 
 // ../myst-to-tex/dist/math.js
+var ENVIRONMENTS2 = [
+  "equation",
+  "multline",
+  "gather",
+  "align",
+  "alignat",
+  "flalign",
+  "matrix",
+  "pmatrix",
+  "bmatrix",
+  "Bmatrix",
+  "vmatrix",
+  "Vmatrix",
+  "eqnarray"
+];
+var RE_OPEN2 = new RegExp(`^\\\\begin{(${ENVIRONMENTS2.join("|")})([*]?)}`);
+function isAmsmathEnvironment(value) {
+  const matchOpen = value.trim().match(RE_OPEN2);
+  if (!matchOpen)
+    return false;
+  const [, environment2, star3] = matchOpen;
+  const end = `\\end{${environment2}${star3}}`;
+  const matchClose = value.trim().endsWith(end);
+  if (!matchClose)
+    return false;
+  return true;
+}
 function addMacrosToState(value, state) {
   if (!state.options.math)
     return;
@@ -300517,15 +300639,22 @@ var math4 = (node3, state) => {
     state.write(node3.value);
     state.write(" \\)");
   } else {
-    state.write(`\\begin{equation${enumerated === false ? "*" : ""}}
+    const isAmsMath = isAmsmathEnvironment(node3.value);
+    if (isAmsMath) {
+      state.ensureNewLine();
+      state.write(node3.value);
+      state.ensureNewLine(true);
+    } else {
+      state.write(`\\begin{equation${enumerated === false ? "*" : ""}}
 `);
-    if (label) {
-      state.write(`\\label{${label}}`);
+      if (label) {
+        state.write(`\\label{${label}}`);
+      }
+      state.ensureNewLine();
+      state.write(node3.value);
+      state.ensureNewLine(true);
+      state.write(`\\end{equation${enumerated === false ? "*" : ""}}`);
     }
-    state.ensureNewLine();
-    state.write(node3.value);
-    state.ensureNewLine(true);
-    state.write(`\\end{equation${enumerated === false ? "*" : ""}}`);
   }
   if (!state.data.isInTable)
     state.closeBlock(node3);
@@ -302646,7 +302775,9 @@ ${node3.value}
     state.renderChildren(node3, 0, " ");
   },
   cite(node3, state) {
-    state.write(`#cite(<${node3.label}>`);
+    const needsLabel = !/^[a-zA-Z0-9_\-:.]+$/.test(node3.label);
+    const label = needsLabel ? `label("${node3.label}")` : `<${node3.label}>`;
+    state.write(`#cite(${label}`);
     if (node3.kind === "narrative")
       state.write(`, form: "prose"`);
     if (node3.suffix)
@@ -302794,7 +302925,7 @@ function isTypstAvailable() {
 }
 async function runTypstExecutable(session, typstFile) {
   if (!isTypstAvailable()) {
-    session.log.debug("typst CLI must be installed to build PDFs from typst");
+    session.log.error("The typst CLI must be installed to build PDFs with typst");
     return;
   }
   if (import_node_path49.default.extname(typstFile) !== ".typ") {