Skip to content

rspack-contrib/rsbuild-plugin-open-graph

BranchesTags

Repository files navigation

rsbuild-plugin-open-graph

An Rsbuild plugin to generate Open Graph meta tags.

npm version license

Usage

Install:

npm add rsbuild-plugin-open-graph -D

Add plugin to your rsbuild.config.ts:

// rsbuild.config.ts
import { pluginOpenGraph } from 'rsbuild-plugin-open-graph';

export default {
  plugins: [
    pluginOpenGraph({
      // options
    }),
  ],
};

Example

  • Config:
pluginOpenGraph({
  title: 'Rsbuild',
  type: 'website',
  url: 'https://rsbuild.dev/',
  image: 'https://rsbuild.dev/og-image.png',
  description: 'The Rspack-based build tool',
  twitter: {
    site: '@rspack_dev',
    card: 'summary_large_image',
  },
});
  • Generated HTML:
<html>
  <head>
    <meta property="og:url" content="https://rsbuild.dev/" />
    <meta property="og:type" content="website" />
    <meta property="og:title" content="Rsbuild" />
    <meta property="og:image" content="https://rsbuild.dev/og-image.png" />
    <meta property="og:description" content="