https://github.com/jaredlunde/snowpack-plugin-mdx

Use the MDX compiler to build .mdx and .md files in Snowpack
https://github.com/jaredlunde/snowpack-plugin-mdx

mdx mdx-js snowpack snowpack-mdx snowpack-plugin

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jaredlunde/snowpack-plugin-mdx
• Owner: jaredLunde
• License: mit
• Created: 2020-07-24T21:15:57.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T12:22:44.000Z (about 2 years ago)
• Last Synced: 2024-09-30T05:21:46.123Z (3 months ago)
• Topics: mdx, mdx-js, snowpack, snowpack-mdx, snowpack-plugin
• Language: TypeScript
• Homepage:
• Size: 2.67 MB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  


    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

```js

// snowpack.config.json

{

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

}

```

#### Plugin Options

````typescript

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

  /**

   * Override the default renderer

   *

   * @default ```js

   *   import React from 'react'

   *   import { mdx } from '＠mdx-js/react'

   * ```

   */

  renderer?: string

}

````

## LICENSE

MIT