创建一个remark插件以提取MDX阅读时间

本指南介绍如何创建一个remark插件,在将MDX文件作为ES模块导入时,使阅读时间数据可用。


Remark是一个强大的Markdown处理器,可以用来创建自定义插件以转换Markdown内容。当使用remark解析Markdown文件时,内容会被转换成抽象语法树(AST),可以通过插件进行操作。

为了提供更好的用户体验,通常会显示文章的估计阅读时间。在本指南中,我们将创建一个remark插件,从MDX文件中提取阅读时间数据,并在将MDX文件作为ES模块导入时使其可用。

开始

首先创建一个MDX文件:

# Hello, world!
​
This is an example MDX file.

假设我们使用Vite作为打包工具,并且使用官方的@mdx-js/rollup插件来转换MDX文件,因此我们可以将MDX文件作为ES模块导入。Vite的配置应该如下所示:

import { defineConfig } from 'vite';
​
export default defineConfig({
  plugins: [
    {
      // `enforce: 'pre'` 是使MDX插件生效所必需的
      enforce: 'pre',
      ...mdx({
        // ...配置
      }),
    },
  ],
});

如果我们将MDX文件作为ES模块导入,内容将是一个对象,其中default属性包含编译后的JSX。例如:

const mdx = await import('./example.mdx');
console.log(mdx
  • 11
    点赞
  • 9
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

幻想多巴胺

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值