Skip to content

Add social image #419

Description

@fflaten

Add a social/opengraph image to improve share cards in social media platforms etc.

Image

Which image?
Size: max 1200 × 630 pixels (aspect ratio of 1.91:1)

Can be configured in docusaurus.config.js:

const config = {
  ..
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        ..
      ],
      // Social image for sharing, sets og:image and twitter:image meta-tags. Path relative to /static folder
      image: 'img/logo.png',

Preview-deployments can be tested using something like: https://www.opengraph.to/u/pester.dev/docs/commands/Should-BeEquivalent

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions