# `@nolebase/vitepress-plugin-og-image`

A vitepress plugin to generate [Open Graph Protocol](https://ogp.me/) previewing images (a.k.a. [social media cards](https://www.semrush.com/blog/open-graph/)) for your site.

## Install

### Npm

```shell
npm i @nolebase/vitepress-plugin-og-image -D
```

### Yarn

```shell
yarn add @nolebase/vitepress-plugin-og-image -D
```

### Pnpm

```shell
pnpm add @nolebase/vitepress-plugin-og-image -D
```

## Documentation

Please refer to [Previewing image generation](https://nolebase-integrations.ayaka.io/pages/en/integrations/vitepress-plugin-og-image/) for more information.