From 463047d5b0de4efd7d4446c031590ff5cb05b594 Mon Sep 17 00:00:00 2001 From: Kenneth Ormandy Date: Tue, 20 Apr 2021 01:58:44 -0700 Subject: [PATCH] chore(gatsby-plugin-mdx): Document CommonMark option (#30669) Co-authored-by: gatsbybot --- 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..7b2f7173609fb 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