highmark-markdown 0.0.229 → 0.0.232

package/src/elementMap.js

@@ -2,6 +2,7 @@
 
 import { LINK_RULE_NAME,
          LINE_RULE_NAME,
+         EMBED_RULE_NAME,
          IMAGE_RULE_NAME,
          TABLE_RULE_NAME,
          ERROR_RULE_NAME,
@@ -9,8 +10,7 @@ import { LINK_RULE_NAME,
          MARKER_RULE_NAME,
          BULLET_RULE_NAME,
          IGNORE_RULE_NAME,
-         IMPORT_RULE_NAME,
-         IMPORTS_RULE_NAME,
+         INCLUDE_RULE_NAME,
          CONTENTS_RULE_NAME,
          DIVISION_RULE_NAME,
          FOOTNOTE_RULE_NAME,
@@ -26,6 +26,7 @@ import { LINK_RULE_NAME,
          CLASS_NAME_RULE_NAME,
          PLAIN_TEXT_RULE_NAME,
          EMAIL_LINK_RULE_NAME,
+         DIRECTIVES_RULE_NAME,
          END_OF_LINE_RULE_NAME,
          MARKED_TEXT_RULE_NAME,
          INLINE_TEXT_RULE_NAME,
@@ -65,6 +66,10 @@ const elementMap = {
     tagName: "span",
     className: "line"
   },
+  [EMBED_RULE_NAME]: {
+    tagName: null,
+    className: null
+  },
   [IMAGE_RULE_NAME]: {
     tagName: "img",
     className: null
@@ -93,11 +98,7 @@ const elementMap = {
     tagName: null,
     className: null
   },
-  [IMPORT_RULE_NAME]: {
-    tagName: null,
-    className: null
-  },
-  [IMPORTS_RULE_NAME]: {
+  [INCLUDE_RULE_NAME]: {
     tagName: null,
     className: null
   },
@@ -161,6 +162,10 @@ const elementMap = {
     tagName: "a",
     className: "email-link"
   },
+  [DIRECTIVES_RULE_NAME]: {
+    tagName: null,
+    className: null
+  },
   [END_OF_LINE_RULE_NAME]: {
     tagName: null,
     className: null

package/src/example/view.js

@@ -49,9 +49,11 @@ class View extends Element {
               divisionMarkdownNodes
             };
 
-      divisionMarkdownNode.resolveImports(context);
+      divisionMarkdownNode.resolveIncludes(context);
 
       divisionMarkdownNodes.forEach((divisionMarkdownNode) => {
+        divisionMarkdownNode.resolveEmbeddings(context);
+
         divisionMarkdownNode.createFootnotes(context);
       });
 
@@ -143,13 +145,11 @@ class View extends Element {
   static initialMarkdownStyle = `min-height: initial;
 `;
 
-  static initialMarkdown = `# Primary heading
+  static initialMarkdown = `@contents 2
 
-@contents 3
+# Primary heading[^heading]
 
-## Secondary heading
-  
-@import example.md
+@embed introduction.md
 `;
 
   static tagName = "div";
@@ -170,7 +170,11 @@ export default withStyle(View)`
 `;
 
 function importer(filePath, context) {
-  const content = `### Tertiary heading
+  const content = `## Secondary heading
+
+[^heading]: A heading.
+
+@footnotes
         `,
         tokens = markdownLexer.tokenise(content),
         node = markdownParser.parse(tokens),

package/src/markdown/bnf.js

@@ -5,13 +5,7 @@ const bnf = `
     division                ::=  ( subDivision | endOfLine | error )+ ;
     
     
-    subDivision..           ::=  ( endOfLine | <START_OF_CONTENT> ) ( ignore 
-    
-                                                                    | imports 
-    
-                                                                    | contents 
-    
-                                                                    | footnotes 
+    subDivision..           ::=  ( endOfLine | <START_OF_CONTENT> ) ( directives 
     
                                                                     | primaryHeading 
                              
@@ -81,13 +75,16 @@ const bnf = `
     blockListing            ::=  blockListingStart blockText blockListingEnd ;
 
 
-    ignore                  ::=  "@"<NO_WHITESPACE>"ignore" ;
+    directives              ::=  ( embed | ignore | include | contents | footnotes )+ ;
 
 
-    imports                 ::=  import+ ;
+    embed                   ::=  "@"<NO_WHITESPACE>"embed" [path] endOfLine ;
+
+
+    ignore                  ::=  "@"<NO_WHITESPACE>"ignore" ;
 
 
-    import                  ::=  "@"<NO_WHITESPACE>"import" [path] endOfLine ;
+    include                 ::=  "@"<NO_WHITESPACE>"include" [path] endOfLine ;
 
 
     contents                ::=  "@"<NO_WHITESPACE>"contents" [number]? endOfLine ;

package/src/mixins/node.js

@@ -1,11 +1,5 @@
 "use strict";
 
-function addChildNode(childNode) {
-  const childNodes = this.getChildNodes();
-
-  childNodes.push(childNode);
-}
-
 function removeChildNode(childNode) {
   const childNodes = this.getChildNodes(),
         index = childNodes.indexOf(childNode),
@@ -15,13 +9,25 @@ function removeChildNode(childNode) {
   childNodes.splice(start, deleteCount);
 }
 
-function replaceChildNode(replacedChildNode, replacementChildNode) {
+function prependChildNode(childNode) {
+  const childNodes = this.getChildNodes();
+
+  childNodes.unshift(childNode);
+}
+
+function appendChildNode(childNode) {
+  const childNodes = this.getChildNodes();
+
+  childNodes.push(childNode);
+}
+
+function replaceChildNodes(replacedChildNode, replacementChildNodes) {
   const childNodes = this.getChildNodes(),
         index = childNodes.indexOf(replacedChildNode),
         start = index,  ///
         deleteCount = 1;
 
-  childNodes.splice(start, deleteCount, replacementChildNode);
+  childNodes.splice(start, deleteCount, ...replacementChildNodes);
 }
 
 function getDescendantNodes(descendantNodes = []) {
@@ -45,9 +51,10 @@ function getDescendantNodes(descendantNodes = []) {
 }
 
 const nodeMixins = {
-  addChildNode,
   removeChildNode,
-  replaceChildNode,
+  appendChildNode,
+  prependChildNode,
+  replaceChildNodes,
   getDescendantNodes
 };
 

package/src/node/markdown/contentsLink.js

@@ -2,8 +2,8 @@
 
 import { arrayUtilities } from "necessary";
 
-import ClonedNode from "../../clonedNode";
 import MarkdownNode from "../../node/markdown";
+import ReplacementNodeAndTokens from "../../replacementNodeAndTokens";
 
 import { HREF_ATTRIBUTE_NAME } from "../../attributeNames";
 import { CONTENTS_LINK_RULE_NAME } from "../../ruleNames";
@@ -59,11 +59,11 @@ export default class ContentsLinkMarkdownNode extends MarkdownNode {
 
     if (headingMarkdownNode !== null) {
       const node = headingMarkdownNode, ///
-            clonedNode = ClonedNode.fromNode(node, context),
-            childNodes = clonedNode.getChildNodes(),
+            replacementNodeAndTokens = ReplacementNodeAndTokens.fromNode(node, context),
+            childNodes = replacementNodeAndTokens.getChildNodes(),
             ruleName = CONTENTS_LINK_RULE_NAME,
             opacity = null,
-            tokens = clonedNode.getTokens(),
+            tokens = replacementNodeAndTokens.getTokens(),
             identifier = headingMarkdownNode.identifier(context);
 
       contentsLinkMarkdownNode = MarkdownNode.fromRuleNameChildNodesAndOpacity(ContentsLinkMarkdownNode, ruleName, childNodes, opacity, tokens, identifier);

package/src/node/markdown/{imports.js → directives.js}

@@ -2,7 +2,7 @@
 
 import MarkdownNode from "../../node/markdown";
 
-export default class ImportsMarkdownNode extends MarkdownNode {
+export default class DirectivesMarkdownNode extends MarkdownNode {
   asHTML(indent, context) {
     const childNodesHTML = this.childNodesAsHTML(indent, context),
           html = childNodesHTML;  ///
@@ -10,5 +10,11 @@ export default class ImportsMarkdownNode extends MarkdownNode {
     return html;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(ImportsMarkdownNode, ruleName, childNodes, opacity); }
+  createDOMElement(context) {
+    const domElement = null;
+
+    return domElement;
+  }
+
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(DirectivesMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown/division.js

@@ -7,8 +7,12 @@ import ContentsListMarkdownNode from "../../node/markdown/contentsList";
 import FootnotesListMarkdownNode from "../../node/markdown/footnotesList";
 
 import { renumberLinkMarkdownNodes } from "../../utilities/footnotes";
-import { replaceNode, replaceTokens } from "../../utilities/replace";
-import { ignoreMarkdownNodeFromNode, headingMarkdownNodesFromNode, contentsMarkdownNodeFromNode, footnotesMarkdownNodesFromNode } from "../../utilities/query";
+import { replaceNode, replaceNodes, replaceTokens } from "../../utilities/replace";
+import { embedMarkdownNodesFromNode,
+         ignoreMarkdownNodeFromNode,
+         headingMarkdownNodesFromNode,
+         contentsMarkdownNodeFromNode,
+         footnotesMarkdownNodesFromNode } from "../../utilities/query";
 
 const { filter } = arrayUtilities;
 
@@ -105,31 +109,48 @@ export default class DivisionMarkdownNode extends MarkdownNode {
 
   createFootnotes(context) {
     const node = this,  ///
-          footnotesMarkdownNodes = footnotesMarkdownNodesFromNode(node);
+          footnotesMarkdownNodes = footnotesMarkdownNodesFromNode(node),
+          footnotesMarkdownNodesLength = footnotesMarkdownNodes.length;
 
-    footnotesMarkdownNodes.forEach((footnotesMarkdownNode) => {
-      let childNode,
-          parentNode;
+    if (footnotesMarkdownNodesLength > 0) {
+      const divisionMarkdownNode = this,  ///
+            footnotesListMarkdownNode = FootnotesListMarkdownNode.fromDivisionMarkdownNode(divisionMarkdownNode, context);
+
+      if (footnotesListMarkdownNode !== null) {
+        const childNode = footnotesListMarkdownNode;  ///
+
+        divisionMarkdownNode.appendChildNode(childNode);
+
+        renumberLinkMarkdownNodes(divisionMarkdownNode, footnotesListMarkdownNode, context)
+      }
+    }
+  }
 
-      childNode = footnotesMarkdownNode;  ///
+  resolveEmbeddings(context) {
+    const node = this,  ///
+          embedMarkdownNodes = embedMarkdownNodesFromNode(node);
 
-      parentNode = this.findParentNode(childNode);
+    embedMarkdownNodes.map((embedMarkdownNode) => {
+      const replacementNodeAndTokens = embedMarkdownNode.replacementNodeAndTokens(context);
 
-      const subDivisionMarkdownNode = parentNode;  ///
+      if (replacementNodeAndTokens !== null) {
+        let tokens;
 
-      childNode = subDivisionMarkdownNode;  ///
+        tokens = replacementNodeAndTokens.getTokens();
 
-      parentNode = this.findParentNode(childNode);
+        const childNodes = replacementNodeAndTokens.getChildNodes(),
+              replacementNodes = childNodes, ///
+              replacementTokens = tokens; ///
 
-      const divisionMarkdownNode = parentNode,  ///
-            footnotesListMarkdownNode = FootnotesListMarkdownNode.fromDivisionMarkdownNode(divisionMarkdownNode, context);
+        ({ tokens } = context);
 
-      if (footnotesListMarkdownNode !== null) {
-        childNode = footnotesListMarkdownNode;  ///
+        const childNode = embedMarkdownNode,  ///
+              parentNode = this.findParentNode(childNode),
+              replacedNode = embedMarkdownNode; ///
 
-        divisionMarkdownNode.addChildNode(childNode);
+        replaceNodes(replacementNodes, replacedNode, parentNode);
 
-        renumberLinkMarkdownNodes(divisionMarkdownNode, footnotesListMarkdownNode, context)
+        replaceTokens(replacementTokens, replacedNode, tokens);
       }
     });
   }

package/src/node/markdown/emailLink.js

@@ -80,11 +80,17 @@ class EmailLinkMarkdownNode extends MarkdownNode {
   }
 
   createChildNodeDOMElements(context) {
-    const inlineText = this.inlineText(context),
-          content = (inlineText !== null) ?
-                      inlineText :
-                        this.content(context),
-          textNode = document.createTextNode(content),
+    const inlineText = this.inlineText(context);
+
+    let content;
+
+    if (inlineText !== null) {
+      content = inlineText; ///
+    } else {
+      content = this.content(context);
+    }
+
+    const textNode = document.createTextNode(content),
           domElement = textNode; ///
 
     this.addDOMElement(domElement);

package/src/node/markdown/embee.js

@@ -0,0 +1,50 @@
+"use strict";
+
+import { arrayUtilities } from "necessary";
+
+import MarkdownNode from "../../node/markdown";
+import ReplacementNodeAndTokens from "../../replacementNodeAndTokens";
+
+const { fourth } = arrayUtilities;
+
+export default class EmbedMarkdownNode extends MarkdownNode {
+  replacementNodeAndTokens(context) {
+    let replacementNodeAndTokens = null;
+
+    const { importer = null } = context;
+
+    if (importer !== null) {
+      const filePath = this.filePath(context);
+
+      importer(filePath, context);
+
+      const { importedNode = null,
+              importedTokens = null } = context;
+
+      if (importedNode !== null) {
+        delete context.importedNode;
+        delete context.importedTokens;
+        delete context.importedClassName;
+
+        const node = importedNode,  ///
+              tokens = importedTokens;  ///
+
+        replacementNodeAndTokens = ReplacementNodeAndTokens.fromNodeAndTokens(node, tokens);
+      }
+    }
+
+    return replacementNodeAndTokens;
+  }
+
+  filePath(context) {
+    const childNodes = this.getChildNodes(),
+          fourthChildNode = fourth(childNodes),
+          pathTerminalNode  = fourthChildNode, ///
+          pathTerminalNodeContent = pathTerminalNode.getContent(),
+          filePath = pathTerminalNodeContent; ///
+
+    return filePath;
+  }
+
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(EmbedMarkdownNode, ruleName, childNodes, opacity); }
+}

package/src/node/markdown/heading.js

@@ -18,7 +18,7 @@ export default class HeadingMarkdownNode extends MarkdownNode {
           anchorMarkdownNode = AnchorMarkdownNode.fromIdentifier(identifier),
           childNode = anchorMarkdownNode; ///
 
-    this.addChildNode(childNode);
+    this.prependChildNode(childNode);
   }
 
   identifier(context) {
@@ -45,11 +45,11 @@ export default class HeadingMarkdownNode extends MarkdownNode {
 function identifierFromPlainText(plainText) {
   plainText = plainText.toLowerCase();  ///
 
-  plainText = removedLeadingWhitespace(plainText);
+  plainText = removedLeadingWhitespace(plainText);  ///
 
-  plainText = removeNonAlphabeticAndSpaceCharacters(plainText);
+  plainText = removeNonAlphabeticAndSpaceCharacters(plainText); ///
 
-  plainText = replaceSpacesWithHyphens(plainText);
+  plainText = replaceSpacesWithHyphens(plainText);  ///
 
   const identifier = plainText; ///
 

package/src/node/markdown/{import.js → include.js}

@@ -6,8 +6,8 @@ import MarkdownNode from "../../node/markdown";
 
 const { push, fourth } = arrayUtilities;
 
-export default class ImportMarkdownNode extends MarkdownNode {
-  resolveImports(context) {
+export default class IncludeMarkdownNode extends MarkdownNode {
+  resolveIncludes(context) {
     let html = null;
 
     const { importer = null } = context;
@@ -21,11 +21,11 @@ export default class ImportMarkdownNode extends MarkdownNode {
               importedTokens = null,
               importedClassName = null } = context;
 
-      delete context.importedNode;
-      delete context.importedTokens;
-      delete context.importedClassName;
-
       if (importedNode !== null) {
+        delete context.importedNode;
+        delete context.importedTokens;
+        delete context.importedClassName;
+
         const { tokens, divisionMarkdownNodes } = context,
               divisionMarkdownNode = importedNode,  ///
               divisionClassName = importedClassName,  ///
@@ -39,7 +39,7 @@ export default class ImportMarkdownNode extends MarkdownNode {
           divisionMarkdownNodes.push(divisionMarkdownNode);
         }
 
-        divisionMarkdownNode.resolveImports(context);
+        divisionMarkdownNode.resolveIncludes(context);
       }
     }
 
@@ -56,5 +56,5 @@ export default class ImportMarkdownNode extends MarkdownNode {
     return filePath;
   }
 
-  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(ImportMarkdownNode, ruleName, childNodes, opacity); }
+  static fromRuleNameChildNodesAndOpacity(ruleName, childNodes, opacity) { return MarkdownNode.fromRuleNameChildNodesAndOpacity(IncludeMarkdownNode, ruleName, childNodes, opacity); }
 }

package/src/node/markdown.js

@@ -94,7 +94,7 @@ class MarkdownNode extends NonTerminalNode {
     return attributeValue;
   }
 
-  resolveImports(context) {
+  resolveIncludes(context) {
     const childNodes = this.getChildNodes();
 
     childNodes.forEach((childNode) => {
@@ -104,7 +104,22 @@ class MarkdownNode extends NonTerminalNode {
         const nonTerminalNode = childNode,  ///
               markdownNode = nonTerminalNode; ///
 
-        markdownNode.resolveImports(context);
+        markdownNode.resolveIncludes(context);
+      }
+    });
+  }
+
+  resolveEmbeddings(context) {
+    const childNodes = this.getChildNodes();
+
+    childNodes.forEach((childNode) => {
+      const childNodeNonTerminalNode = childNode.isNonTerminalNode();
+
+      if (childNodeNonTerminalNode) {
+        const nonTerminalNode = childNode,  ///
+              markdownNode = nonTerminalNode; ///
+
+        markdownNode.resolveEmbeddings(context);
       }
     });
   }

package/src/nodeMap.js

@@ -2,6 +2,7 @@
 
 import LinkMarkdownNode from "./node/markdown/link";
 import LineMarkdownNode from "./node/markdown/line";
+import EmbedMarkdownNode from "./node/markdown/embee";
 import ImageMarkdownNode from "./node/markdown/image";
 import TableMarkdownNode from "./node/markdown/table";
 import ErrorMarkdownNode from "./node/markdown/error";
@@ -9,8 +10,7 @@ import AnchorMarkdownNode from "./node/markdown/anchor";
 import MarkerMarkdownNode from "./node/markdown/marker";
 import BulletMarkdownNode from "./node/markdown/bullet";
 import IgnoreMarkdownNode from "./node/markdown/ignore";
-import ImportMarkdownNode from "./node/markdown/import";
-import ImportsMarkdownNode from "./node/markdown/imports";
+import IncludeMarkdownNode from "./node/markdown/include";
 import ContentsMarkdownNode from "./node/markdown/contents";
 import DivisionMarkdownNode from "./node/markdown/division";
 import FootnoteMarkdownNode from "./node/markdown/footnote";
@@ -27,6 +27,7 @@ import ClassNameMarkdownNode from "./node/markdown/className";
 import PlainTextMarkdownNode from "./node/markdown/plainText";
 import EmailLinkMarkdownNode from "./node/markdown/emailLink";
 import EndOfLineMarkdownNode from "./node/markdown/endOfLine";
+import DirectivesMarkdownNode from "./node/markdown/directives";
 import MarkedTextMarkdownNode from "./node/markdown/markedText";
 import InlineTextMarkdownNode from "./node/markdown/inlineText";
 import StrongTextMarkdownNode from "./node/markdown/strongText";
@@ -56,6 +57,7 @@ import StronglyEmphasisedTextMarkdownNode from "./node/markdown/stronglyEmphasis
 
 import { LINK_RULE_NAME,
          LINE_RULE_NAME,
+         EMBED_RULE_NAME,
          IMAGE_RULE_NAME,
          TABLE_RULE_NAME,
          ERROR_RULE_NAME,
@@ -63,8 +65,7 @@ import { LINK_RULE_NAME,
          MARKER_RULE_NAME,
          BULLET_RULE_NAME,
          IGNORE_RULE_NAME,
-         IMPORT_RULE_NAME,
-         IMPORTS_RULE_NAME,
+         INCLUDE_RULE_NAME,
          CONTENTS_RULE_NAME,
          DIVISION_RULE_NAME,
          FOOTNOTE_RULE_NAME,
@@ -80,6 +81,7 @@ import { LINK_RULE_NAME,
          CLASS_NAME_RULE_NAME,
          PLAIN_TEXT_RULE_NAME,
          EMAIL_LINK_RULE_NAME,
+         DIRECTIVES_RULE_NAME,
          END_OF_LINE_RULE_NAME,
          MARKED_TEXT_RULE_NAME,
          INLINE_TEXT_RULE_NAME,
@@ -111,6 +113,7 @@ import { LINK_RULE_NAME,
 const nodeMap = {
   [LINK_RULE_NAME]: LinkMarkdownNode,
   [LINE_RULE_NAME]: LineMarkdownNode,
+  [EMBED_RULE_NAME]: EmbedMarkdownNode,
   [IMAGE_RULE_NAME]: ImageMarkdownNode,
   [TABLE_RULE_NAME]: TableMarkdownNode,
   [ERROR_RULE_NAME]: ErrorMarkdownNode,
@@ -118,8 +121,7 @@ const nodeMap = {
   [MARKER_RULE_NAME]: MarkerMarkdownNode,
   [BULLET_RULE_NAME]: BulletMarkdownNode,
   [IGNORE_RULE_NAME]: IgnoreMarkdownNode,
-  [IMPORT_RULE_NAME]: ImportMarkdownNode,
-  [IMPORTS_RULE_NAME]: ImportsMarkdownNode,
+  [INCLUDE_RULE_NAME]: IncludeMarkdownNode,
   [CONTENTS_RULE_NAME]: ContentsMarkdownNode,
   [DIVISION_RULE_NAME]: DivisionMarkdownNode,
   [FOOTNOTE_RULE_NAME]: FootnoteMarkdownNode,
@@ -135,6 +137,7 @@ const nodeMap = {
   [CLASS_NAME_RULE_NAME]: ClassNameMarkdownNode,
   [PLAIN_TEXT_RULE_NAME]: PlainTextMarkdownNode,
   [EMAIL_LINK_RULE_NAME]: EmailLinkMarkdownNode,
+  [DIRECTIVES_RULE_NAME]: DirectivesMarkdownNode,
   [END_OF_LINE_RULE_NAME]: EndOfLineMarkdownNode,
   [MARKED_TEXT_RULE_NAME]: MarkedTextMarkdownNode,
   [INLINE_TEXT_RULE_NAME]: InlineTextMarkdownNode,

package/src/{clonedNode.js → replacementNodeAndTokens.js}

@@ -1,6 +1,6 @@
 "use strict";
 
-export default class ClonedNode {
+export default class ReplacementNodeAndTokens {
   constructor(node, tokens) {
     this.node = node;
     this.tokens = tokens;
@@ -28,9 +28,15 @@ export default class ClonedNode {
 
     tokens = replacementTokens; ///
 
-    const clonedNode = new ClonedNode(node, tokens);
+    const replacementNodeAndTokens = new ReplacementNodeAndTokens(node, tokens);
 
-    return clonedNode;
+    return replacementNodeAndTokens;
+  }
+
+  static fromNodeAndTokens(node, tokens) {
+    const replacementNodeAndTokens = new ReplacementNodeAndTokens(node, tokens);
+
+    return replacementNodeAndTokens;
   }
 }
 

package/src/ruleNames.js

@@ -2,6 +2,7 @@
 
 export const LINK_RULE_NAME = "link";
 export const LINE_RULE_NAME = "line";
+export const EMBED_RULE_NAME = "embed";
 export const IMAGE_RULE_NAME = "image";
 export const TABLE_RULE_NAME = "table";
 export const ERROR_RULE_NAME = "error";
@@ -9,8 +10,7 @@ export const ANCHOR_RULE_NAME = "anchor";
 export const MARKER_RULE_NAME = "marker";
 export const BULLET_RULE_NAME = "bullet";
 export const IGNORE_RULE_NAME = "ignore";
-export const IMPORT_RULE_NAME = "import";
-export const IMPORTS_RULE_NAME = "imports";
+export const INCLUDE_RULE_NAME = "include";
 export const CONTENTS_RULE_NAME = "contents";
 export const DIVISION_RULE_NAME = "division";
 export const FOOTNOTE_RULE_NAME = "footnote";
@@ -26,6 +26,7 @@ export const BLOCK_TEXT_RULE_NAME = "blockText";
 export const CLASS_NAME_RULE_NAME = "className";
 export const PLAIN_TEXT_RULE_NAME = "plainText";
 export const EMAIL_LINK_RULE_NAME = "emailLink";
+export const DIRECTIVES_RULE_NAME = "directives";
 export const END_OF_LINE_RULE_NAME = "endOfLine";
 export const MARKED_TEXT_RULE_NAME = "markedText";
 export const INLINE_TEXT_RULE_NAME = "inlineText";
@@ -60,6 +61,7 @@ export const STRONGLY_EMPHASISED_TEXT_RULE_NAME = "stronglyEmphasisedText";
 const ruleNames = {
   LINK_RULE_NAME,
   LINE_RULE_NAME,
+  EMBED_RULE_NAME,
   IMAGE_RULE_NAME,
   TABLE_RULE_NAME,
   ERROR_RULE_NAME,
@@ -67,8 +69,7 @@ const ruleNames = {
   MARKER_RULE_NAME,
   BULLET_RULE_NAME,
   IGNORE_RULE_NAME,
-  IMPORT_RULE_NAME,
-  IMPORTS_RULE_NAME,
+  INCLUDE_RULE_NAME,
   CONTENTS_RULE_NAME,
   DIVISION_RULE_NAME,
   FOOTNOTE_RULE_NAME,
@@ -84,6 +85,7 @@ const ruleNames = {
   CLASS_NAME_RULE_NAME,
   PLAIN_TEXT_RULE_NAME,
   EMAIL_LINK_RULE_NAME,
+  DIRECTIVES_RULE_NAME,
   END_OF_LINE_RULE_NAME,
   MARKED_TEXT_RULE_NAME,
   INLINE_TEXT_RULE_NAME,

package/src/utilities/query.js

@@ -6,6 +6,7 @@ import { arrayUtilities } from "necessary";
 const { first, push } = arrayUtilities;
 
 const linkMarkdownNodesQuery = Query.fromExpression(`//link`),
+      embedMarkdownNodesQuery = Query.fromExpression(`//embed`),
       ignoreMarkdownNodeQuery = Query.fromExpression(`//ignore`),
       headingMarkdownNodesQuery = Query.fromExpression(`//primaryHeading|secondaryHeading|tertiaryHeading|quaternaryHeading`),
       contentsMarkdownNodeQuery = Query.fromExpression(`//contents`),
@@ -50,6 +51,12 @@ export function linkMarkdownNodesFromNode(node, linkMarkdownNodes = []) {
   return linkMarkdownNodes;
 }
 
+export function embedMarkdownNodesFromNode(node, embedMarkdownNodes = []) {
+  nodesFromNodeAndQuery(node, embedMarkdownNodesQuery, embedMarkdownNodes);
+
+  return embedMarkdownNodes;
+}
+
 export function ignoreMarkdownNodeFromNode(node) {
   const ignoreMarkdownNode = nodeFromNodeAndQuery(node, ignoreMarkdownNodeQuery);
 
@@ -100,6 +107,7 @@ export function linkReferenceOrFootnotesMarkdownNodesFromNode(node, linkReferenc
 
 export default {
   linkMarkdownNodesFromNode,
+  embedMarkdownNodesFromNode,
   ignoreMarkdownNodeFromNode,
   contentsMarkdownNodeFromNode,
   footnotesMarkdownNodeFromNode,