From 1a888b175d19ecc13a82b9c160fd745f3c31d7d2 Mon Sep 17 00:00:00 2001 From: Kenneth Ormandy Date: Sat, 3 Apr 2021 11:49:24 -0700 Subject: [PATCH 1/2] Document CommonMark option for gatsby-plugin-mdx --- packages/gatsby-plugin-mdx/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/gatsby-plugin-mdx/README.md b/packages/gatsby-plugin-mdx/README.md index 06daa6684b7e0..f6e834eaed18e 100644 --- a/packages/gatsby-plugin-mdx/README.md +++ b/packages/gatsby-plugin-mdx/README.md @@ -128,6 +128,7 @@ scope, and more. | [`rehypePlugins`](#rehype-plugins) | `[]` | Specify rehype plugins | | [`mediaTypes`](#media-types) | `["text/markdown", "text/x-markdown"]` | Determine which media types are processed by MDX | | [`shouldBlockNodeFromTransformation`](#shouldblocknodefromtransformation) | `(node) => false` | Disable MDX transformation for nodes where this function returns true | +| [`commonmark`](#commonmark) | `false` | Use CommonMark | #### Extensions @@ -466,6 +467,10 @@ module.exports = { } ``` +#### CommonMark + +MDX will be parsed using CommonMark. + ### Components MDX and `gatsby-plugin-mdx` use components for different things like rendering From b384fbb590623328e1855c65f9eee06fe7ebf92d Mon Sep 17 00:00:00 2001 From: gatsbybot Date: Tue, 20 Apr 2021 08:50:32 +0000 Subject: [PATCH 2/2] chore: format --- packages/gatsby-plugin-mdx/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/gatsby-plugin-mdx/README.md b/packages/gatsby-plugin-mdx/README.md index f6e834eaed18e..7b2f7173609fb 100644 --- a/packages/gatsby-plugin-mdx/README.md +++ b/packages/gatsby-plugin-mdx/README.md @@ -128,7 +128,7 @@ scope, and more. | [`rehypePlugins`](#rehype-plugins) | `[]` | Specify rehype plugins | | [`mediaTypes`](#media-types) | `["text/markdown", "text/x-markdown"]` | Determine which media types are processed by MDX | | [`shouldBlockNodeFromTransformation`](#shouldblocknodefromtransformation) | `(node) => false` | Disable MDX transformation for nodes where this function returns true | -| [`commonmark`](#commonmark) | `false` | Use CommonMark | +| [`commonmark`](#commonmark) | `false` | Use CommonMark | #### Extensions