Fix TOC links for HTML code tags (nodejs#234)

kevjin · Onur Laru · commit df0abde7ded2 · 2019-04-10T12:51:21.000+02:00
* fix: Fix code tags in TOC links

* style: Use prettier formatting

* style: Code format function titles

* fix: Make util function more safe

Co-Authored-By: kevjin &lt;qaz111id@gmail.com&gt;

* style: Run prettier
diff --git a/src/components/toc.tsx b/src/components/toc.tsx
@@ -1,4 +1,5 @@
 import React from 'react';
+import { fixTocCodeTag } from '../util/tocFormatter';
 
 type Props = {
   heading: string;
@@ -9,6 +10,7 @@ const TOC = ({ heading, tableOfContents }: Props) => {
   if (!tableOfContents) {
     return null;
   }
+  tableOfContents = fixTocCodeTag(tableOfContents);
 
   return (
     <details className="toc">
diff --git a/src/documentation/0032-javascript-timers/index.md b/src/documentation/0032-javascript-timers/index.md
@@ -5,7 +5,7 @@ authors: flaviocopes, MylesBorins, LaRuaNa, amiller-gh, ahmadawais
 section: Getting Started
 ---
 
-## setTimeout()
+## `setTimeout()`
 
 When writing JavaScript code, you might want to delay the execution of a function.
 
@@ -61,7 +61,7 @@ This is especially useful to avoid blocking the CPU on intensive tasks and let o
 
 > Some browsers (IE and Edge) implement a `setImmediate()` method that does this same exact functionality, but it's not standard and [unavailable on other browsers](https://caniuse.com/#feat=setimmediate). But it's a standard function in Node.js.
 
-## setInterval()
+## `setInterval()`
 
 `setInterval` is a function similar to `setTimeout`, with a difference: instead of running the callback function once, it will run it forever, at the specific time interval you specify (in milliseconds):
 
diff --git a/src/documentation/0034-javascript-promises/index.md b/src/documentation/0034-javascript-promises/index.md
@@ -212,7 +212,7 @@ new Promise((resolve, reject) => {
 
 ## Orchestrating promises
 
-### Promise.all()
+### `Promise.all()`
 
 If you need to synchronize different promises, `Promise.all()` helps you define a list of promises, and execute something when they are all resolved.
 
@@ -241,7 +241,7 @@ Promise.all([f1, f2]).then(([res1, res2]) => {
 
 You are not limited to using `fetch` of course, **any promise can be used in this fashion**.
 
-### Promise.race()
+### `Promise.race()`
 
 `Promise.race()` runs when the first of the promises you pass to it resolves, and it runs the attached callback just once, with the result of the first promise resolved.
 
diff --git a/src/util/tocFormatter.ts b/src/util/tocFormatter.ts
@@ -0,0 +1,6 @@
+// See related issue: https://github.com/gatsbyjs/gatsby/issues/8982
+export function fixTocCodeTag(tocLinks: string = '') {
+  const lessThanSignRegex = /&#x3C;/gi;
+
+  return tocLinks.replace(lessThanSignRegex, '<');
+}
