snowpack-plugin-mdx

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

snowpack-plugin-mdx

★ 9 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<hr>
<div>
  <h1>
    snowpack-plugin-mdx
  </h1>
  <blockquote>Use the <a href="https://github.com/mdx-js/mdx/tree/master/packages/mdx">MDX compiler</a> to build <code>.mdx</code> and <code>.md</code> files in <a href="https://www.snowpack.dev/">Snowpack</a></blockquote>
  <pre>npm i -D snowpack-plugin-mdx @mdx-js/mdx @mdx-js/react</pre>

</div>

## 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<string, any>
  /**
   * Override the default renderer
   *
   * @default ```js
   *   import React from 'react'
   *   import { mdx } from '＠mdx-js/react'
   * ```
   */
  renderer?: string
}
````

## LICENSE

MIT

snowpack-plugin-mdx

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README