跳转到内容

添加阅读时间

创建一个在你的 Markdown 或 MDX 文件的 frontmatter 中添加阅读所需时间的 remark 插件。使用该属性来为每个页面显示所需的阅读时间。

操作步骤

段落标题 操作步骤

  1. 安装辅助包

    安装如下两个辅助包：

    Terminal window
    npm install reading-time mdast-util-to-string

  2. 创建一个 remark 插件

    该插件使用 mdast-util-to-string 包来获取 Markdown 文件的文本内容，然后将文本传递给 reading-time 包以计算阅读所需的分钟数。

    remark-reading-time.mjs
    import getReadingTime from 'reading-time';
    import { toString } from 'mdast-util-to-string';
    

    export function remarkReadingTime() {
      return function (tree, { data }) {
        const textOnPage = toString(tree);
        const readingTime = getReadingTime(textOnPage);
        // readingTime.text 会以友好的字符串形式给出阅读时间，例如 "3 min read"。
        data.astro.frontmatter.minutesRead = readingTime.text;
      };
    }

  3. 将插件添加到你的配置中：

    astro.config.mjs
    import { defineConfig } from 'astro/config';
    import { remarkReadingTime } from './remark-reading-time.mjs';
    

    export default defineConfig({
      markdown: {
        remarkPlugins: [remarkReadingTime],
      },
    });

    现在所有的 Markdown 文档的 frontmatter 中都会有一个计算出来的 minutesRead 属性。

  4. 显示阅读时间

    如果你的博客文章存储在 内容集合 中，通过 entry.render() 函数获取 remarkPluginFrontmatter，然后在模板中你喜欢的位置渲染 minutesRead。

    src/pages/posts/[slug].astro
    ---
    import { CollectionEntry, getCollection } from 'astro:content';
    

    export async function getStaticPaths() {
      const blog = await getCollection('blog');
      return blog.map(entry => ({
        params: { slug: entry.slug },
        props: { entry },
      }));
    }
    

    const { entry } = Astro.props;
    const { Content, remarkPluginFrontmatter } = await entry.render();
    ---
    

    <html>
      <head>...</head>
      <body>
        ...
        <p>{remarkPluginFrontmatter.minutesRead}</p>
        ...
      </body>
    </html>

    如果你使用的是 Markdown 布局，在布局模板中通过 Astro.props 来获取 frontmatter 中的 minutesRead 属性。

    src/layouts/BlogLayout.astro
    ---
    const { minutesRead } = Astro.props.frontmatter;
    ---
    

    <html>
      <head>...</head>
      <body>
        <p>{minutesRead}</p>
        <slot />
      </body>
    </html>