Added support for multiblock questions / answers in Markdown parser

See interpreter/Readme and unit tests for documentation.

Author: andymatuschak

packages/interpreter/Readme.md

@@ -46,7 +46,34 @@ For example, here's an excerpt of some notes I wrote as I was studying Service W
 >
 > A. Two.
 
-The empty line between the question and answer is optional. The question and answer cannot currently span multiple paragraphs: the paragraph including `Q. ` or `A. ` is extracted as that field.
+The empty line between the question and answer is optional. So you can also write it like this, with a newline separating the question and answer.
+
+> Q. How many dimensions are in a qubit's vector space? \
+> A. Two.
+
+If you'd like to make the question or answer field span multiple Markdown blocks, add a newline after the `Q.` or `A.` prefix, like this:
+
+```
+Q.
+What is this a picture of?
+
+1. Apples
+2. Bananas
+3. Pears
+
+A.
+Apples
+
+
+Q. How to do the hokey pokey?
+A.
+1. You put your right foot in
+2. You put your right foot out
+3. You put your right foot in
+4. And you shake it all about
+```
+
+As shown above, you can mix and match the "multi-block" style with the "single-line" style. In "multi-block" mode, all the content after the prefix will be included in the field, until the next question, heading, or horizontal rule (`---`).
 
 #### Creating cloze deletion prompts
 

packages/interpreter/src/interpreters/markdown/MarkdownInterpreter.ts

@@ -11,7 +11,7 @@ import {
   IngestibleSource,
   IngestibleSourceIdentifier,
 } from "@withorbit/ingester";
-import mdast, * as Mdast from "mdast";
+import * as Mdast from "mdast";
 import { selectAll } from "unist-util-select";
 import { Hasher } from "../../hasher/hasher.js";
 import { InterpretableFile, Interpreter } from "../../interpreter.js";
@@ -78,13 +78,13 @@ function convertInterpreterPromptToIngestible(prompt: Prompt): TaskSpec {
         type: TaskContentType.QA,
         body: {
           text: processor
-            .stringify(prompt.question as unknown as mdast.Root)
+            .stringify({ type: "root", children: prompt.question })
             .trimEnd(),
           attachments: [],
         },
         answer: {
           text: processor
-            .stringify(prompt.answer as unknown as mdast.Root)
+            .stringify({ type: "root", children: prompt.answer })
             .trimEnd(),
           attachments: [],
         },

packages/interpreter/src/interpreters/markdown/markdown.test.ts

@@ -68,12 +68,12 @@ test("cloze in backlink section", () => {
   expect(prompts).toHaveLength(0);
 });
 
-test("QA prompt in blockquote", () => {
+test("QA prompts aren't recognized in blockquote", () => {
   const prompts = getPrompts(`# Heading
 
 > Q. Test.
 > A. Answer.
 `);
 
-  expect(prompts).toHaveLength(1);
+  expect(prompts).toHaveLength(0);
 });

packages/interpreter/src/interpreters/markdown/markdown.ts

@@ -26,10 +26,10 @@ export interface ClozePrompt extends JsonMap {
 }
 
 export const qaPromptType = "qaPrompt";
-export interface QAPrompt extends JsonMap {
+export interface QAPrompt {
   type: typeof qaPromptType;
-  question: mdast.RootContent & JsonMap;
-  answer: mdast.RootContent & JsonMap;
+  question: mdast.RootContent[];
+  answer: mdast.RootContent[];
 }
 
 export type Prompt = ClozePrompt | QAPrompt;
@@ -43,8 +43,8 @@ export interface ClozePromptNode extends unist.Node {
 export const qaPromptNodeType = "qaPrompt";
 export interface QAPromptNode extends unist.Node {
   type: typeof qaPromptNodeType;
-  question: mdast.RootContent;
-  answer: mdast.RootContent;
+  question: mdast.RootContent[];
+  answer: mdast.RootContent[];
 }
 
 type NodeWithParent = mdast.Nodes & {
@@ -104,8 +104,8 @@ export function findAllPrompts(tree: mdast.Root): Prompt[] {
     const qaPromptNode = n as QAPromptNode;
     const qaPrompt: QAPrompt = {
       type: "qaPrompt",
-      question: qaPromptNode.question as mdast.RootContent & JsonMap,
-      answer: qaPromptNode.answer as mdast.RootContent & JsonMap,
+      question: qaPromptNode.question,
+      answer: qaPromptNode.answer,
     };
     return qaPrompt;
   });