Work around an issue where GitHub Pages cannot render <p></p> inside a pipes-and-dashes table (even though GHFM supports this)

pgonzal · pgonzal · commit 4afad6ded7de · 2019-01-09T13:25:40.000-08:00
diff --git a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts
@@ -44,7 +44,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
   }
 
   /** @override */
-  protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext): void {
+  protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void {
     const writer: IndentedWriter = context.writer;
 
     switch (docNode.kind) {
@@ -71,7 +71,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
 
         writer.increaseIndent('> ');
 
-        this.writeNode(docNoteBox.content, context);
+        this.writeNode(docNoteBox.content, context, false);
         writer.ensureNewLine();
 
         writer.decreaseIndent();
@@ -105,7 +105,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
           if (docTable.header) {
             const cell: DocTableCell | undefined = docTable.header.cells[i];
             if (cell) {
-              this.writeNode(cell.content, context);
+              this.writeNode(cell.content, context, false);
             }
           }
           writer.write(' |');
@@ -123,7 +123,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
           writer.write('| ');
           for (const cell of row.cells) {
             writer.write(' ');
-            this.writeNode(cell.content, context);
+            this.writeNode(cell.content, context, false);
             writer.write(' |');
           }
           writer.writeLine();
@@ -146,7 +146,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
         break;
       }
       default:
-        super.writeNode(docNode, context);
+        super.writeNode(docNode, context, false);
     }
   }
 
diff --git a/apps/api-documenter/src/markdown/MarkdownEmitter.ts b/apps/api-documenter/src/markdown/MarkdownEmitter.ts
@@ -58,7 +58,7 @@ export class MarkdownEmitter {
       options
     };
 
-    this.writeNode(docNode, context);
+    this.writeNode(docNode, context, false);
 
     writer.ensureNewLine(); // finish the last line
 
@@ -79,7 +79,7 @@ export class MarkdownEmitter {
   /**
    * @virtual
    */
-  protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext): void {
+  protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void {
     const writer: IndentedWriter = context.writer;
 
     switch (docNode.kind) {
@@ -122,9 +122,14 @@ export class MarkdownEmitter {
         const docParagraph: DocParagraph = docNode as DocParagraph;
         const trimmedParagraph: DocParagraph = DocNodeTransforms.trimSpacesInParagraph(docParagraph);
         if (context.insideTable) {
-          writer.write('<p>');
-          this.writeNodes(trimmedParagraph.nodes, context);
-          writer.write('</p>');
+          if (docNodeSiblings) {
+            writer.write('<p>');
+            this.writeNodes(trimmedParagraph.nodes, context);
+            writer.write('</p>');
+          } else {
+            // Special case:  If we are the only element inside this table cell, then we can omit the <p></p> container.
+            this.writeNodes(trimmedParagraph.nodes, context);
+          }
         } else {
           this.writeNodes(trimmedParagraph.nodes, context);
           writer.ensureNewLine();
@@ -237,7 +242,7 @@ export class MarkdownEmitter {
 
   protected writeNodes(docNodes: ReadonlyArray<DocNode>, context: IMarkdownEmitterContext): void {
     for (const docNode of docNodes) {
-      this.writeNode(docNode, context);
+      this.writeNode(docNode, context, docNodes.length > 1);
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/** @override */`
`47`		`- protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext): void {`
	`47`	`+ protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void {`
`48`	`48`	`const writer: IndentedWriter = context.writer;`
`49`	`49`
`50`	`50`	`switch (docNode.kind) {`
`@@ -71,7 +71,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`71`	`71`
`72`	`72`	`writer.increaseIndent('> ');`
`73`	`73`
`74`		`- this.writeNode(docNoteBox.content, context);`
	`74`	`+ this.writeNode(docNoteBox.content, context, false);`
`75`	`75`	`writer.ensureNewLine();`
`76`	`76`
`77`	`77`	`writer.decreaseIndent();`
`@@ -105,7 +105,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`105`	`105`	`if (docTable.header) {`
`106`	`106`	`const cell: DocTableCell \| undefined = docTable.header.cells[i];`
`107`	`107`	`if (cell) {`
`108`		`- this.writeNode(cell.content, context);`
	`108`	`+ this.writeNode(cell.content, context, false);`
`109`	`109`	`}`
`110`	`110`	`}`
`111`	`111`	`writer.write(' \|');`
`@@ -123,7 +123,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`123`	`123`	`writer.write('\| ');`
`124`	`124`	`for (const cell of row.cells) {`
`125`	`125`	`writer.write(' ');`
`126`		`- this.writeNode(cell.content, context);`
	`126`	`+ this.writeNode(cell.content, context, false);`
`127`	`127`	`writer.write(' \|');`
`128`	`128`	`}`
`129`	`129`	`writer.writeLine();`
`@@ -146,7 +146,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {`
`146`	`146`	`break;`
`147`	`147`	`}`
`148`	`148`	`default:`
`149`		`- super.writeNode(docNode, context);`
	`149`	`+ super.writeNode(docNode, context, false);`
`150`	`150`	`}`
`151`	`151`	`}`
`152`	`152`