插件

更新: 10/19/2024 字数: 0 字时长: 0 分钟

时间线

采用了 @HanochMa/vitepress-markdown-timeline 的项目

Demo：https://hanochma.github.io/daily/2023-04

pnpmyarnnpmbun

pnpm add -D vitepress-markdown-timeline

yarn add -D vitepress-markdown-timeline

npm install vitepress-markdown-timeline

bun add -D vitepress-markdown-timeline

在 config.mts 中注册 markdown 解析插件

import timeline from "vitepress-markdown-timeline"; 

export default {
  markdown: { 
    //行号显示
    lineNumbers: true, 

    //时间线
    config: (md) => {
      md.use(timeline);
    },
  }, 
}

在 .vitepress/theme/index.ts 中引入时间线样式

说明

如果你没有这个文件，就自己新建

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

// 只需添加以下一行代码，引入时间线样式
import "vitepress-markdown-timeline/dist/theme/index.css";

export default {
  extends: DefaultTheme,
}

最后我们在markdown文件中，按格式使用即可

输入：

::: timeline 2023-04-24
- 一个非常棒的开源项目 H5-Dooring 目前 star 3.1k
  - 开源地址 https://github.com/MrXujiang/h5-Dooring
  - 基本介绍 http://h5.dooring.cn/doc/zh/guide/
- 《深入浅出webpack》 http://webpack.wuhaolin.cn/
:::

::: timeline 2023-04-23
:::

谷歌分析

利用插件 google-analytics ，来查看网站访问量

这里我们用 @ZhongxuYang/vitepress-plugin-google-analytics 的插件

pnpmyarnnpmbun

pnpm add -D vitepress-plugin-google-analytics

yarn add -D vitepress-plugin-google-analytics

npm install vitepress-plugin-google-analytics

bun add -D vitepress-plugin-google-analytics

在 .vitepress/theme/index.ts 中引入

// .vitepress/theme/index.ts
import DefaultTheme from "vitepress/theme"
import googleAnalytics from 'vitepress-plugin-google-analytics'

export default {
  extends: DefaultTheme,
  enhanceApp({app}) {
    googleAnalytics({
      id: 'G-******', //跟踪ID，在analytics.google.com注册即可
    }),
  },
}

图片缩放

Vuepress是可以直接安装插件 medium-zoom 的，非常好用

但是Vitepress直接用不了，在 vitepress的issues中找到了方法#854

pnpmyarnnpmbun

pnpm add -D medium-zoom

yarn add -D medium-zoom

npm install medium-zoom

bun add -D medium-zoom

在 .vitepress/theme/index.ts 添加如下代码，并保存

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

import mediumZoom from 'medium-zoom';
import { onMounted, watch, nextTick } from 'vue';
import { useRoute } from 'vitepress';

export default {
  extends: DefaultTheme,

  setup() {
    const route = useRoute();
    const initZoom = () => {
      // mediumZoom('[data-zoomable]', { background: 'var(--vp-c-bg)' }); // 默认
      mediumZoom('.main img', { background: 'var(--vp-c-bg)' }); // 不显式添加{data-zoomable}的情况下为所有图像启用此功能
    };
    onMounted(() => {
      initZoom();
    });
    watch(
      () => route.path,
      () => nextTick(() => initZoom())
    );
  },

}

点击图片后，还是能看到导航栏，加一个遮挡样式

在 .vitepress/theme/style/var.css 中加入如下代码，并保存

css

/* .vitepress/theme/style/var.css */

.medium-zoom-overlay {
  z-index: 30;
}

.medium-zoom-image {
  z-index: 9999 !important;/* 给的值是21，但是实测盖不住，直接999 */
}

测试一下效果，还不错

但是

有个小bug，每次修改完需要刷新才能起效，不过不影响使用

看板娘

第一次接触的人会比较懵，其实就是在右下角有个二次元的人物，类似电子宠物

这里使用 @xinlei3166/vitepress-theme-website 的 Live2D 插件

pnpmyarnnpmbun

pnpm add -D vitepress-theme-website

yarn add -D vitepress-theme-website

npm install vitepress-theme-website

bun add -D vitepress-theme-website

在 .vitepress/theme/index.ts 粘贴下面代码并保存

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

import { useLive2d } from 'vitepress-theme-website'

export default {
  extends: DefaultTheme,

  setup() {

    //看板娘
    useLive2d({
      enable: true,
      model: {
        url: 'https://raw.githubusercontent.com/iCharlesZ/vscode-live2d-models/master/model-library/hibiki/hibiki.model.json'
      },
      display: {
        position: 'right',
        width: '135px',
        height: '300px',
        xOffset: '35px',
        yOffset: '5px'
      },
      mobile: {
        show: true
      },
      react: {
        opacity: 0.8
      }
    })

  }
}

想要更换模型在 @iCharlesZ 这里找，替换 model 中的 url 链接即可

useLive2d({
  model: {
  url: 'https://raw.githubusercontent.com/iCharlesZ/vscode-live2d-models/master/model-library/bilibili-22/index.json'
  }
})

浏览量

基本上使用的是不蒜子，免费的且足够好用

pnpmyarnnpmbun

pnpm add -D busuanzi.pure.js

yarn add -D busuanzi.pure.js

npm install busuanzi.pure.js

bun add -D busuanzi.pure.js

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

import { inBrowser } from 'vitepress'
import busuanzi from 'busuanzi.pure.js'

export default {
  extends: DefaultTheme,

  enhanceApp({ app , router }) {
    if (inBrowser) {
      router.onAfterRouteChanged = () => {
        busuanzi.fetch()
      }
    }
  },
  
}

使用就很简单了，复制到页面中使用即可

说明

本地开发出现数字即算成功，等你部署后会显示正确的数值

html

本站总访问量 <span id="busuanzi_value_site_pv" /> 次
本站访客数 <span id="busuanzi_value_site_uv" /> 人次

但是这也不好看啊，那就根据自己需求选择封装吧

封装演示

仅首页显示：组件使用示例
所有页面底部：插槽使用示例

自动侧边栏

发现一款自动侧边栏，简单好用 @jooy2/vitepress-sidebar

安装文档：https://vitepress-sidebar.jooy2.com/guide/getting-started

pnpmyarnnpm

pnpm add -D vitepress-sidebar

yarn add -D vitepress-sidebar

npm i -D vitepress-sidebar

在 configs.mts 中引入配置，可以根据作者api文档按需修改

// .vitepress/configs.mts
import { generateSidebar } from 'vitepress-sidebar';

const vitepressSidebarOptions = {
  /* Options... */
};

export default defineConfig({
  themeConfig: {
    sidebar: generateSidebar({
      /*
       * For detailed instructions, see the links below:
       * https://vitepress-sidebar.jooy2.com/guide/api
       */
      documentRootPath: '/docs', //文档根目录
      // scanStartPath: null,
      // resolvePath: null,
      // useTitleFromFileHeading: true,
      // useTitleFromFrontmatter: true,
      // frontmatterTitleFieldName: 'title',
      // useFolderTitleFromIndexFile: false, //是否使用层级首页文件名做分级标题
      // useFolderLinkFromIndexFile: false, //是否链接至层级首页文件
      // hyphenToSpace: true,
      // underscoreToSpace: true,
      // capitalizeFirst: false,
      // capitalizeEachWords: false,
      collapsed: false, //折叠组关闭
      collapseDepth: 2, //折叠组2级菜单
      // sortMenusByName: false,
      // sortMenusByFrontmatterOrder: false,
      // sortMenusByFrontmatterDate: false,
      // sortMenusOrderByDescending: false,
      // sortMenusOrderNumericallyFromTitle: false,
      // sortMenusOrderNumericallyFromLink: false,
      // frontmatterOrderDefaultValue: 0,
      // manualSortFileNameByPriority: ['first.md', 'second', 'third.md'], //手动排序，文件夹不用带后缀
      removePrefixAfterOrdering: false, //删除前缀，必须与prefixSeparator一起使用
      prefixSeparator: '.', //删除前缀的符号
      // excludeFiles: ['first.md', 'secret.md'],
      // excludeFilesByFrontmatterFieldName: 'exclude',
      // excludeFolders: ['secret-folder'],
      // includeDotFiles: false,
      // includeRootIndexFile: false,
      // includeFolderIndexFile: false, //是否包含层级主页
      // includeEmptyFolder: false,
      // rootGroupText: 'Contents',
      // rootGroupLink: 'https://github.com/jooy2',
      // rootGroupCollapsed: false,
      // convertSameNameSubFileToGroupIndexPage: false,
      // folderLinkNotIncludesFileName: false,
      // keepMarkdownSyntaxFromTitle: false,
      // debugPrint: false,
    }),
  },
})

为了避免安装插件影响教程，就写一个简单的示例

stackblitz演示：https://stackblitz.com/edit/vite-y1rga7

等待生成后可查看，左侧是目录，右侧是页面
注意：插件在读取目录之后，你再修改文件名，需要重启才能生效

Todo

为什么Vitepress没有任务列表，在 issues#1923 和 issues#413 里找到了这个问题

开发者认为

Vitepress并不需要这个，也可以通过 markdown-it 实现，但 vitepress集成的markdown-it 并没有此功能

看到推荐的 markdown-it-task-lists 年久失修，找了一下可以使用 markdown-it-task-checkbox 实现

实测下来不建议折腾，不如直接使用Emoji表情

我们需要用到另一款插件：markdown-it-task-checkbox

pnpmyarnnpmbun

pnpm add -D markdown-it-task-checkbox

yarn add -D markdown-it-task-checkbox

npm install markdown-it-task-checkbox --save

bun add -D markdown-it-task-checkbox

如果根据文档配置的话是不行的，源码也比较久了，使用的是 commonjs 同步函数，而Vitepress使用的是 ES module 异步函数

关于 CJS 和 ESM

commonjs：简称CJS，module.exports exports 导出，require 导入

ES module：简称ESM，export 导出，import 导入

这个我们在最开始 Vitepress前言的时候也提到过

// .vitepress/config.mts
import taskLists from 'markdown-it-task-checkbox'

export default defineConfig({
  markdown: {
    config: (md) => {
      md.use(taskLists, {
        disabled: true,
        divWrap: false,
        divClass: 'checkbox',
        idPrefix: 'cbx_',
        ulClass: 'task-list',
        liClass: 'task-list-item',
      })
    }
  },
})

关于引用报错但未爆红

无法找到模块“markdown-it-task-checkbox”的声明文件。“/node_modules/.pnpm/markdown-it-task-checkbox@1.0.6/node_modules/markdown-it-task-checkbox/index.js”隐式拥有 "any" 类型。
尝试使用 npm i --save-dev @types/markdown-it-task-checkbox (如果存在)，或者添加一个包含 declare module 'markdown-it-task-checkbox'; 的新声明(.d.ts)文件ts(7016)

解决：

在 congfig.mts同级目录新建一个 type.d.ts 文件

粘贴 declare module 'markdown-it-task-checkbox'; 代码保存

说明

disabled 改成 false ，可以激活勾选框

版本过低，跑不起来，我们直接安装 @types/node

pnpmyarnnpmbun

pnpm add -d @types/node

yarn add -D @types/node

npm install @types/node --save

bun add -D @types/node

自己测试效果即可

[ ] 吃饭
[ ] 睡觉
[x] 打豆豆

最后，我还是推荐直接使用 emoji表情，简简单单

✅ 吃饭
⬜ 睡觉

代码组图标

使用的是 @yuyinws/vitepress-plugin-group-icons

参照教程安装：https://vpgi.vercel.app/

pnpmyarnnpmbun

pnpm add -D vitepress-plugin-group-icons

yarn add -D vitepress-plugin-group-icons

npm install vitepress-plugin-group-icons

bun add -D vitepress-plugin-group-icons

然后在 config.mts 中配置

groupIconMdPlugin 报错？

请备份配置及文件后，重新安装VitePress

// .vitepress/config.mts
import { defineConfig } from 'vitepress'
import { groupIconMdPlugin, groupIconVitePlugin } from 'vitepress-plugin-group-icons'

export default defineConfig({

  markdown: {
    config(md) { 
      md.use(groupIconMdPlugin) //代码组图标
    },
  },

  vite: { 
    plugins: [
      groupIconVitePlugin() //代码组图标
    ],
  },

})

最后还需要再 index.ts 中引入样式

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

import 'virtual:group-icons.css' //代码组样式

export default {
  extends: DefaultTheme,
}

使用时，请确保代码后有对应的文字触发

::: code-group
```sh [pnpm]
pnpm -v
```

```sh [yarn]
yarn -v
```

```sh [bun]
bun -v
```
:::

已经内置的常用图标有

export const builtInIcons: Record<string, string> = {
  // package manager
  pnpm: 'logos:pnpm',
  npm: 'logos:npm-icon',
  yarn: 'logos:yarn',
  bun: 'logos:bun',
  // framework
  vue: 'logos:vue',
  svelte: 'logos:svelte-icon',
  angular: 'logos:angular-icon',
  react: 'logos:react',
  next: 'logos:nextjs-icon',
  nuxt: 'logos:nuxt-icon',
  solid: 'logos:solidjs-icon',
  // bundler
  rollup: 'logos:rollupjs',
  webpack: 'logos:webpack',
  vite: 'logos:vitejs',
  esbuild: 'logos:esbuild',
}

那么如何自定义呢，我们先在 iconify 中找到中意的图标

说明

本地图标格式：只能使用相对路径
远程图标格式：必须是 logos:***

图标名复制后，可以在 config.mts 中配置

// .vitepress/config.mts
import { defineConfig } from 'vitepress'
import { groupIconMdPlugin, groupIconVitePlugin, localIconLoader } from 'vitepress-plugin-group-icons'

export default defineConfig({

  markdown: {
    config(md) {
      md.use(groupIconMdPlugin) //代码组图标
    },
  },

  vite: {
    plugins: [
      groupIconVitePlugin({ 
        customIcon: {
          ts: localIconLoader(import.meta.url, '../public/svg/typescript.svg'), //本地ts图标导入
          js: 'logos:javascript', //js图标
          md: 'logos:markdown', //markdown图标
          css: 'logos:css-3', //css图标
        },
      })
    ],
  },

})

来吧看看，效果如何

tsjsmdcss

console.log("I'm TypeScript");

console.log("I'm JavaScript");

Markdown图标演示

css

h1 {
  background: red;
}

禁用F12

使用的是 @cellinlab/vitepress-protect-plugin

pnpmyarnnpmbun

pnpm add -D vitepress-protect-plugin

yarn add -D vitepress-protect-plugin

npm install vitepress-protect-plugin

bun add -D vitepress-protect-plugin

然后在 config.mts 中配置，不用的功能不配置即可

import { defineConfig } from "vitepress"
import vitepressProtectPlugin from "vitepress-protect-plugin"

export default defineConfig({
  // other VitePress configs...
  vite: {
    plugins: [
      vitepressProtectPlugin({
        disableF12: true, // 禁用F12开发者模式
        disableCopy: true, // 禁用文本复制
        disableSelect: true, // 禁用文本选择
      }),
    ],
  },
})

从个人角度而言，Giscus 最佳，就用它演示，其他的这里就不赘述了

为什么使用 Giscus

评论系统	说明
Valine	不用登录账号即可评论，但容易产生垃圾评论，其次没有评论提醒通知
Waline	是Valine的升级版，登录后方可评论，有通知，但是需要自己部署服务端
Twikoo	不用登录账号即可评论，但容易产生垃圾评论，有通知，但是需要自己部署服务端
Artalk	可设置是否启用登录账号后评论，有通知，但是需要自己部署服务端
utteranc	GitHub登录后方可评论，评论数据在 GitHub issues 中，评论后有邮件通知，无需部署服务端，但UI样式一般，且移动端不显示头像
gitalk	GitHub登录后方可评论，评论数据在 GitHub issues 中，评论后有邮件通知，无需部署服务端，UI样式一般，评论不支持点赞
⭐Giscus	GitHub登录后方可评论，评论数据在 GitHub Discussions 中，评论后有邮件通知，无需部署服务端，UI爱了

关于 @xinlei3166 的 waline 插件

在使用看板娘发时候就已经装好了，直接引用就行了

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme'

import { useWaline } from 'vitepress-theme-website'

export default {
  extends: DefaultTheme,

  setup() {

    useWaline({
      serverURL: 'https://you_url.com'
    }),

  }
}

记得 serverURL 换成自己的即可，但是作者的插件有个bug，暗黑模式下看不清字

所以要用 waline 话就参考官方的教程

安装giscus

Giscus 是一个基于 GitHub Discussion 的评论系统，启用简便

进 Giscus App官网：https://github.com/apps/giscus

点击 Install 安装

选择 Only select repositories，再指定一个你想开启讨论的仓库

注意

仓库必须是公开的，私有的不行

想单独放评论，新建一个也可

查看

完成后可以在个人头像-设置-应用 Applications 中看到

开启讨论

因为giscus会把评论数据都放到讨论 discussions 中

我们进入要开启讨论的仓库，点设置 - 勾选讨论 Settings - discussions

生成数据

进入官网：https://giscus.app/zh-CN

输入自己的仓库链接，满足条件会提示可用

下拉到 Discussion 分类我们按推荐的选 Announcements ，懒加载评论也可以勾选下

下方就自动生成了你的关键数据

其中 data-repo 、 data-repo-id 、 data-category 和 data-category-id 这4个是我们的关键数据

<script src="https://giscus.app/client.js"
        data-repo="github repository"
        data-repo-id="R_******"
        data-category="Announcements"
        data-category-id="DIC_******"
        data-mapping="pathname"
        data-strict="0"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-input-position="bottom"
        data-theme="preferred_color_scheme"
        data-lang="zh-CN"
        data-loading="lazy"
        crossorigin="anonymous"
        async>
</script>

安装使用

有能力的可以用官方给的js数据封装

我这里用 @T-miracle/vitepress-plugin-comment-with-giscus 的插件

pnpmyarnnpmbun

pnpm add -D vitepress-plugin-comment-with-giscus

yarn add -D vitepress-plugin-comment-with-giscus

npm install vitepress-plugin-comment-with-giscus

bun add -D vitepress-plugin-comment-with-giscus

在 .vitepress/theme/index.ts 中填入下面代码

并将我们之前获取的4个关键数据填入，其他保持默认保存

// .vitepress/theme/index.ts
import DefaultTheme from 'vitepress/theme';
import giscusTalk from 'vitepress-plugin-comment-with-giscus';
import { useData, useRoute } from 'vitepress';

export default {
  extends: DefaultTheme,

  setup() {
    // Get frontmatter and route
    const { frontmatter } = useData();
    const route = useRoute();
        
    // giscus配置
    giscusTalk({
      repo: 'your github repository', //仓库
      repoId: 'your repository id', //仓库ID
      category: 'Announcements', // 讨论分类
      categoryId: 'your category id', //讨论分类ID
      mapping: 'pathname',
      inputPosition: 'bottom',
      lang: 'zh-CN',
      }, 
      {
        frontmatter, route
      },
      //默认值为true，表示已启用，此参数可以忽略；
      //如果为false，则表示未启用
      //您可以使用“comment:true”序言在页面上单独启用它
      true
    );

}

看下底部的效果吧

如果某一页不想启用

我们可以在当前页使用 Frontmatter 关闭

yaml

---
comment: false
---

网站公告

插件 ​

时间线 ​

谷歌分析 ​

图片缩放 ​

看板娘 ​

浏览量 ​

自动侧边栏 ​

Todo ​

代码组图标 ​

禁用F12 ​

评论 ​

安装giscus ​

开启讨论 ​

生成数据 ​

安装使用 ​

插件

时间线

谷歌分析

图片缩放

看板娘

浏览量

自动侧边栏

Todo

代码组图标

禁用F12

评论

安装giscus

开启讨论

生成数据

安装使用