Skip to navigation

@mdx-js/esbuild

MDX 的 esbuild 插件。

内容

这是什么?

该软件包是一个支持 MDX 的 esbuild 插件。

我什么时候应该使用这个?

如果你使用 esbuild(或其他使用 esbuild 的工具),此集成非常有用。

如果你想评估 MDX 代码,则可以使用更底层的编译器 (@mdx-js/mdx)。 为了支持非标准的 JSX 运行时(例如 Vue),也可以使用 @mdx-js/mdx,或者我们的 webpack 加载器(@mdx-js/loader)或 Rollup 插件(@mdx-js/rollup)。

安装

这个包是 仅限 ESM。 在 Node.js(版本 16+)中,使用 npm 安装:

Shell
npm install @mdx-js/esbuild-mdx

使用

使用 esbuild API 执行类似的操作:

TypeScript
import mdx from '@mdx-js/esbuild'
import esbuild from 'esbuild'

await esbuild.build({
  // Replace `index.js` with your entry point that imports MDX files:
  entryPoints: ['index.js'],
  format: 'esm',
  outfile: 'output.js',
  plugins: [mdx({/* jsxImportSource: …, otherOptions… */})]
})

API

该包不导出任何标识符。 默认导出为 mdx

mdx(options?)

创建一个 esbuild 插件来将 MDX 编译为 JS。

esbuild 负责将现代 JavaScript 功能转换为可以在任何你想要的地方使用的语法。 对于其他集成,你可能需要使用 Babel 来实现此目的,但对于 esbuild 则不需要。 有关更多信息,请参阅 esbuild 的文档。

参数
  • optionsOptions,可选) — configuration

返回

ESBuild 插件(Pluginesbuild)。

Options

配置(TypeScript 类型)。

选项与 CompileOptions@mdx-js/mdx 相同。

类型

该包完全采用 TypeScript 类型。 它导出附加类型 Options。 请参阅我们网站上的 § 类型 了解信息。

兼容性

由统一集体维护的项目与 Node.js 的维护版本兼容。

当我们削减新的主要版本时,我们会放弃对未维护的 Node.js 版本的支持。 这意味着我们尝试保持当前版本 @mdx-js/esbuild@^3 与 Node.js 16 兼容。

安全

请参阅我们网站上的 § 安全 了解信息。

贡献

请参阅我们网站上的 § 贡献 了解入门方法。 请参阅 § 支持 了解获取帮助的方法。

该项目有 行为守则。 通过与此存储库、组织或社区交互,你同意遵守其条款。

许可证

MIT © Titus Wormer

MDX 中文网 - 粤ICP备13048890号