为 VuePress 实现一个有序目录插件~

该插件已经发布至:GitHub | npm

如有帮助可以点个 star 支持一下 ~。

VuePress 默认不支持生成有序目录,比如想要下面这种效果:

markdown 复制代码
# 标题 1

## 标题 1-1

### 标题 1-1-1

## 标题 1-2

# 标题 2

目录将显示为:

css 复制代码
1 header 1

1.1 header 1-1

1.1.1 header 1-1-1

1.2 header 1-2

2 header 2

于是花了一点时间研究了 VuePress 的插件系统。

VuePress 架构

以下内容来自 VuePress - 架构

概览

VuePress 的简要架构:

  • Node App 会生成临时文件,包括页面、路由等。
  • Bundler 会将 Client App 和临时文件一起进行打包,就像处理一个普通的 Vue App 一样。

VuePress 分为两个主要部分: Node App 和 Client App:

  • 插件或者主题的入口文件会在 Node App 中被加载。
  • 客户端文件会在 Client App 中被加载,也就是会被 Bundler 处理。比如组件、客户端配置文件等。

核心流程和 Hooks

VuePress 的核心流程以及 插件 API 的 Hooks :

  • init 阶段:
    • 主题和插件会被加载。这意味着插件需要在初始化之前使用。
    • 由于我们要使用 markdown-it 来解析 Markdown 文件,因此需要在加载页面文件之前创建 markdown-it 实例:
      • extendsMarkdownOptions Hook 会被调用,用以创建 markdown-it 实例。
      • extendsMarkdown Hook 会被调用,用以扩展 markdown-it 实例。
    • 页面文件会被加载:
      • extendsPageOptions Hook 会被调用,用以创建页面。
      • extendsPage Hook 会被调用,用以扩展页面对象。
  • prepare 阶段:
    • 临时文件会被生成,因此所有和客户端文件相关的 Hooks 会在此处调用。
  • dev / build 阶段:
    • Bundler 会被加载:
    • extendsBundlerOptions Hook 会被调用,用以生成 Bundler 的配置。
    • alias Hook 和 define Hook 会被用在 Bundler 的配置中,所以它们会在此处调用。

开发插件

开发插件只需要导出一个插件对象,并在对应 Hooks 中实现自己想要的逻辑。

比如要实现有序标题,那么可以在 extendsPage Hooks 中扩展 Page 实例的 headers 属性。

extendsPage

  • 类型: (page: Page, app: App) => void | Promise<void>
  • 详情: 页面扩展。 该 Hook 接收一个函数,在参数中会收到一个 Page 实例。 该 Hook 可以用来在 Page 对象上添加额外的属性,或修改现有的属性等。 值得一提的是,针对 page.datapage.routeMeta 的改动可以在客户端代码中使用。
js 复制代码
module.exports = () => {
  return {
    name: 'vuepress-plugin-ordered-header',
    extendsPage: (page) => {
      // 实现扩展逻辑
    }
  }
}

实现功能

headers: PageHeader[] 数据结构如下:

ts 复制代码
interface PageHeader {
  level: number
  title: string
  slug: string
  children: PageHeader[]
}

每个标题下的子标题会被放入 children 数组,因此需要利用递归实现。

  1. 首先初始化一个计数数组 counter,代表 h1 ~ h6 6 个标题层级。
  2. 在每个标题层级上,首先将对应的层级计数器加一(即 counter[level] = (counter[level] || 0) + 1)。
  3. 然后对于比当前层级更深的计数器(即该标题的子标题)进行重置(即 counter[i] = undefined)。
  4. 再利用 counter 数组给标题增加序号。
  5. 最后返回处理好的 page 对象。
js 复制代码
module.exports = () => {
  return {
    name: 'vuepress-plugin-ordered-header',
    extendsPage: (page) => {
      const counter = Array(6).fill(undefined)

      const reorderHeaders = (headers) => {
        headers.forEach((header) => {
          const level = header.level - 1

          counter[level] = (counter[level] || 0) + 1

          // reset level
          for (let i = level + 1; i < counter.length; i++) {
            counter[i] = undefined
          }

          header.title = `${counter.filter(Number).join('.')} ${header.title}`

          if (header.children) reorderHeaders(header.children)
        })
      }

      reorderHeaders(page.headers)

      return page
    }
  }
}
相关推荐
熊的猫29 分钟前
JS 中的类型 & 类型判断 & 类型转换
前端·javascript·vue.js·chrome·react.js·前端框架·node.js
瑶琴AI前端1 小时前
uniapp组件实现省市区三级联动选择
java·前端·uni-app
会发光的猪。1 小时前
如何在vscode中安装git详细新手教程
前端·ide·git·vscode
FIT2CLOUD飞致云1 小时前
仪表板展示|DataEase看中国:历年双十一电商销售数据分析
数据分析·开源·数据可视化·dataease·双十一
小华同学ai1 小时前
AJ-Report:一款开源且非常强大的数据可视化大屏和报表工具
数据库·信息可视化·开源
CCF ODC2 小时前
倒计时3天 | 2024 CCF中国开源大会仪式解读
开源
我要洋人死2 小时前
导航栏及下拉菜单的实现
前端·css·css3
科技探秘人2 小时前
Chrome与火狐哪个浏览器的隐私追踪功能更好
前端·chrome
科技探秘人2 小时前
Chrome与傲游浏览器性能与功能的深度对比
前端·chrome