README_zh.md

vitepress-plugin-image-viewer

一款基于 viewerjs 的 vitepress 图片查看器（图片预览）插件

安装

# npm 
npm i vitepress-plugin-image-viewer
# yarn
yarn add vitepress-plugin-image-viewer
# pnpm
pnpm add vitepress-plugin-image-viewer
# 提示：如果使用 pnpm 安装，还需要额外安装 viewerjs
pnpm add viewerjs

使用

在 .vitepress/theme/index 中

import DefaultTheme from 'vitepress/theme';
import 'viewerjs/dist/viewer.min.css';
import imageViewer from 'vitepress-plugin-image-viewer';
import vImageViewer from 'vitepress-plugin-image-viewer/lib/vImageViewer.vue';
import { useRoute } from 'vitepress';

export default {
    ...DefaultTheme,
    enhanceApp(ctx) {
        DefaultTheme.enhanceApp(ctx);
        // 注册全局组件，如果你不想使用也可以不添加
        ctx.app.component('vImageViewer', vImageViewer);
        // ...
    },
    setup() {
        // 获取路由
        const route = useRoute();
        // 使用
        imageViewer(route);
    }
};

imageViewer() 接收三个参数：

• route

  路由（这是必需的）

• el

  CSS选择器（默认.vp-doc，可以为空不填写，这不是必需的）

• option

  配置选项（详细配置请看viewerjs option，已有默认配置，这不是必需的）

扩展组件

vImageViewer 组件能编译成一个按钮，点击这个按钮能弹出图片，使用方式如下：

<vImageViewer src="图片地址" alt="描述内容" :inline="false"/>

inline 属性设置为 true，那么它会变成一个行内元素，他不是必需的，默认为 false

更多vitepress插件

这些插件你可能会感兴趣：点我查看更多vitepress插件