snowpack-plugin-mdx

snowpack-plugin-mdx

Use the MDX compiler to build .mdx and .md files in Snowpack

npm i -D snowpack-plugin-mdx @mdx-js/mdx @mdx-js/react

---

Quick start

// snowpack.config.json
{
  "plugins": [["snowpack-plugin-mdx", { /* see "Plugin Options" below */ }]]
}

Plugin Options

interface SnowpackPluginMdxOptions {
  /**
   * Includes only the  specified paths
   */
  include?: string[]
  /**
   * Excludes the specified paths
   */
  exclude?: string[]
  /**
   * These options are passed directly to babel.transformAsync()
   */
  babelOptions?: TransformOptions
  /**
   * These options are passed directly to the MDX compiler
   */
  mdxOptions?: Record<string, any>
  /**
   * Override the default renderer
   *
   * @default ```js
   *   import React from 'react'
   *   import { mdx } from '＠mdx-js/react'
   * ```
   */
  renderer?: string
}

LICENSE

MIT