介绍

介绍

收录了一些适合在 MDX 中使用的 React 组件。

安装

  1. 安装模块:
npm i mdx-elements
  1. 安装 peer 依赖
npx install-peerdeps mdx-elements

组件:

  1. Image 组件: 基于 antd 的图片组件。
  2. Tweet 组件: 内嵌推文。
  3. Badge 组件: 用于显示 npm 安装量、GitHub star 数等 badge 参数。
  4. YouTube 组件: 用于内嵌 YouTube 视频。

使用方法

  1. Nexrta (opens in a new tab)中使用 修改theme.config.jsx文件。
import { components } from "mdx-elements";
 
export default {
  project: {
    link: "https://github.com/try-to-fly/mdx-components",
  },
  components,
};

注意事项

  1. nextj 中需要配置,不然会有报错:
{
  transpilePackages: [
    "react-tweet",
    "mdx-elements",
    "xmind-embed-viewer"
  ],
}