chore: format docs as MDX

jestjs · Mar 5, 2022 · 871a8e7 · 871a8e7
1 parent 095f65e
commit 871a8e7
Show file tree

Hide file tree

Showing 57 changed files with 187 additions and 65 deletions.
diff --git a/docs/Architecture.md b/docs/Architecture.md
@@ -5,10 +5,24 @@ title: Architecture
 
 If you are interested in learning more about how Jest works, understand its architecture, and how Jest is split up into individual reusable packages, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/3YDiloj8_d0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/3YDiloj8_d0"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 If you'd like to learn how to build a testing framework like Jest from scratch, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/B8FbUK0WpVU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/B8FbUK0WpVU"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 There is also a [written guide you can follow](https://cpojer.net/posts/building-a-javascript-testing-framework). It teaches the fundamental concepts of Jest and explains how various parts of Jest can be used to compose a custom testing framework.
diff --git a/docs/CLI.md b/docs/CLI.md
@@ -106,7 +106,7 @@ CLI options take precedence over values from the [Configuration](Configuration.m
 
 :::
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -80,7 +80,7 @@ module.exports = {
 };
 ```
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/docs/ExpectAPI.md b/docs/ExpectAPI.md
@@ -9,7 +9,7 @@ For additional Jest matchers maintained by the Jest Community check out [`jest-e
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/docs/GlobalAPI.md b/docs/GlobalAPI.md
@@ -7,7 +7,7 @@ In your test files, Jest puts each of these methods and objects into the global
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/docs/JestObjectAPI.md b/docs/JestObjectAPI.md
@@ -7,7 +7,7 @@ The `jest` object is automatically in scope within every test file. The methods
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/docs/MockFunctionAPI.md b/docs/MockFunctionAPI.md
@@ -17,15 +17,16 @@ import {jest} from '@jest/globals';
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 
 ---
 
 ## Reference
 
-import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 ### `mockFn.getMockName()`
 

diff --git a/package.json b/package.json
@@ -137,6 +137,15 @@
         "options": {
           "singleQuote": false
         }
+      },
+      {
+        "files": [
+          "docs/*.md",
+          "website/versioned_docs/*/*.md"
+        ],
+        "options": {
+          "parser": "mdx"
+        }
       }
     ]
   },

diff --git a/website/versioned_docs/version-25.x/Architecture.md b/website/versioned_docs/version-25.x/Architecture.md
@@ -5,10 +5,24 @@ title: Architecture
 
 If you are interested in learning more about how Jest works, understand its architecture, and how Jest is split up into individual reusable packages, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/3YDiloj8_d0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/3YDiloj8_d0"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 If you'd like to learn how to build a testing framework like Jest from scratch, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/B8FbUK0WpVU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/B8FbUK0WpVU"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 There is also a [written guide you can follow](https://cpojer.net/posts/building-a-javascript-testing-framework). It teaches the fundamental concepts of Jest and explains how various parts of Jest can be used to compose a custom testing framework.
diff --git a/website/versioned_docs/version-25.x/CLI.md b/website/versioned_docs/version-25.x/CLI.md
@@ -100,7 +100,7 @@ jest --update-snapshot --detectOpenHandles
 
 _Note: CLI options take precedence over values from the [Configuration](Configuration.md)._
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-25.x/Configuration.md b/website/versioned_docs/version-25.x/Configuration.md
@@ -53,7 +53,7 @@ module.exports = {
 };
 ```
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-25.x/ExpectAPI.md b/website/versioned_docs/version-25.x/ExpectAPI.md
@@ -9,7 +9,7 @@ For additional Jest matchers maintained by the Jest Community check out [`jest-e
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-25.x/GlobalAPI.md b/website/versioned_docs/version-25.x/GlobalAPI.md
@@ -7,7 +7,7 @@ In your test files, Jest puts each of these methods and objects into the global
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-25.x/JestObjectAPI.md b/website/versioned_docs/version-25.x/JestObjectAPI.md
@@ -7,7 +7,7 @@ The `jest` object is automatically in scope within every test file. The methods
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-25.x/MockFunctionAPI.md b/website/versioned_docs/version-25.x/MockFunctionAPI.md
@@ -7,7 +7,7 @@ Mock functions are also known as "spies", because they let you spy on the behavi
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-26.x/Architecture.md b/website/versioned_docs/version-26.x/Architecture.md
@@ -5,10 +5,24 @@ title: Architecture
 
 If you are interested in learning more about how Jest works, understand its architecture, and how Jest is split up into individual reusable packages, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/3YDiloj8_d0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/3YDiloj8_d0"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 If you'd like to learn how to build a testing framework like Jest from scratch, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/B8FbUK0WpVU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/B8FbUK0WpVU"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 There is also a [written guide you can follow](https://cpojer.net/posts/building-a-javascript-testing-framework). It teaches the fundamental concepts of Jest and explains how various parts of Jest can be used to compose a custom testing framework.
diff --git a/website/versioned_docs/version-26.x/CLI.md b/website/versioned_docs/version-26.x/CLI.md
@@ -100,7 +100,7 @@ jest --update-snapshot --detectOpenHandles
 
 _Note: CLI options take precedence over values from the [Configuration](Configuration.md)._
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-26.x/Configuration.md b/website/versioned_docs/version-26.x/Configuration.md
@@ -80,7 +80,7 @@ module.exports = {
 };
 ```
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-26.x/ExpectAPI.md b/website/versioned_docs/version-26.x/ExpectAPI.md
@@ -9,7 +9,7 @@ For additional Jest matchers maintained by the Jest Community check out [`jest-e
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-26.x/GlobalAPI.md b/website/versioned_docs/version-26.x/GlobalAPI.md
@@ -7,7 +7,7 @@ In your test files, Jest puts each of these methods and objects into the global
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-26.x/JestObjectAPI.md b/website/versioned_docs/version-26.x/JestObjectAPI.md
@@ -7,7 +7,7 @@ The `jest` object is automatically in scope within every test file. The methods
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-26.x/MockFunctionAPI.md b/website/versioned_docs/version-26.x/MockFunctionAPI.md
@@ -7,7 +7,7 @@ Mock functions are also known as "spies", because they let you spy on the behavi
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-27.0/Architecture.md b/website/versioned_docs/version-27.0/Architecture.md
@@ -5,10 +5,24 @@ title: Architecture
 
 If you are interested in learning more about how Jest works, understand its architecture, and how Jest is split up into individual reusable packages, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/3YDiloj8_d0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/3YDiloj8_d0"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 If you'd like to learn how to build a testing framework like Jest from scratch, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/B8FbUK0WpVU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/B8FbUK0WpVU"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 There is also a [written guide you can follow](https://cpojer.net/posts/building-a-javascript-testing-framework). It teaches the fundamental concepts of Jest and explains how various parts of Jest can be used to compose a custom testing framework.
diff --git a/website/versioned_docs/version-27.0/CLI.md b/website/versioned_docs/version-27.0/CLI.md
@@ -100,7 +100,7 @@ jest --update-snapshot --detectOpenHandles
 
 _Note: CLI options take precedence over values from the [Configuration](Configuration.md)._
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-27.0/Configuration.md b/website/versioned_docs/version-27.0/Configuration.md
@@ -80,7 +80,7 @@ module.exports = {
 };
 ```
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-27.0/ExpectAPI.md b/website/versioned_docs/version-27.0/ExpectAPI.md
@@ -9,7 +9,7 @@ For additional Jest matchers maintained by the Jest Community check out [`jest-e
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-27.0/GlobalAPI.md b/website/versioned_docs/version-27.0/GlobalAPI.md
@@ -7,7 +7,7 @@ In your test files, Jest puts each of these methods and objects into the global
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-27.0/JestObjectAPI.md b/website/versioned_docs/version-27.0/JestObjectAPI.md
@@ -7,7 +7,7 @@ The `jest` object is automatically in scope within every test file. The methods
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-27.0/MockFunctionAPI.md b/website/versioned_docs/version-27.0/MockFunctionAPI.md
@@ -7,7 +7,7 @@ Mock functions are also known as "spies", because they let you spy on the behavi
 
 ## Methods
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(1)} />
 

diff --git a/website/versioned_docs/version-27.1/Architecture.md b/website/versioned_docs/version-27.1/Architecture.md
@@ -5,10 +5,24 @@ title: Architecture
 
 If you are interested in learning more about how Jest works, understand its architecture, and how Jest is split up into individual reusable packages, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/3YDiloj8_d0" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/3YDiloj8_d0"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 If you'd like to learn how to build a testing framework like Jest from scratch, check out this video:
 
-<iframe width="560" height="315" src="https://www.youtube.com/embed/B8FbUK0WpVU" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe
+  width="560"
+  height="315"
+  src="https://www.youtube.com/embed/B8FbUK0WpVU"
+  frameborder="0"
+  allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture"
+  allowfullscreen
+></iframe>
 
 There is also a [written guide you can follow](https://cpojer.net/posts/building-a-javascript-testing-framework). It teaches the fundamental concepts of Jest and explains how various parts of Jest can be used to compose a custom testing framework.
diff --git a/website/versioned_docs/version-27.1/CLI.md b/website/versioned_docs/version-27.1/CLI.md
@@ -100,7 +100,7 @@ jest --update-snapshot --detectOpenHandles
 
 _Note: CLI options take precedence over values from the [Configuration](Configuration.md)._
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />
 

diff --git a/website/versioned_docs/version-27.1/Configuration.md b/website/versioned_docs/version-27.1/Configuration.md
@@ -80,7 +80,7 @@ module.exports = {
 };
 ```
 
-import TOCInline from "@theme/TOCInline"
+import TOCInline from '@theme/TOCInline';
 
 <TOCInline toc={toc.slice(2)} />