Socket
Socket
Sign inDemoInstall

rsbuild-plugin-open-graph

Package Overview
Dependencies
41
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    rsbuild-plugin-open-graph

An Rsbuild plugin to generate Open Graph meta tags.


Version published
Weekly downloads
485
decreased by-55.22%
Maintainers
1
Install size
8.49 kB
Created
Weekly downloads
 

Readme

Source

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="The Rspack-based build tool" />
    <meta property="twitter:site" content="@rspack_dev" />
    <meta property="twitter:card" content="summary_large_image" />
  </head>
  <body></body>
</html>

Options

Here are the available options:

type PluginOpenGraphOptions = {
  url?: string;
  type?: string;
  title?: string;
  image?: string;
  audio?: string;
  video?: string;
  locale?: string;
  determiner?: 'a' | 'an' | 'the' | 'auto' | '';
  description?: string;
  twitter?: {
    site?: string;
    card?: string;
    title?: string;
    image?: string;
    player?: string;
    creator?: string;
    description?: string;
  };
};

See the following documents for details:

License

MIT.

FAQs

Last updated on 25 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc