Skip to content

Open Graph Image ​

Slidev allows you to set the Open Graph image via the seoMeta.ogImage option in the headmatter:

md
---
seoMeta:
  ogImage: https://url.to.your.image.png
---

# Your slides here

Learn more about SEO Meta Tags.

Local Image ​

If you have ./og-image.png in your project root, Slidev will grab it as the Open Graph image automatically without any configuration.

Auto-generate ​

Since v52.1.0, Slidev supports auto-generating the Open Graph image from the first slide.

You can set seoMeta.ogImage to auto to enable this feature.

md
---
seoMeta:
  ogImage: auto
---

It will use playwright to capture the first slide and save it as ./og-image.png (same as slidev export). You may also commit the generated image to your repository to avoid the auto-generation. Or if you generate it on CI, you might also want to setup the playwright environment.

CI Environment ​

When generating the OG image on CI (e.g. GitHub Actions), the runner may not have the fonts required to render your slides correctly. Non-Latin characters such as Japanese, Chinese, or Korean will appear as boxes (tofu) if the system fonts are missing.

Install system fonts ​

On Ubuntu-based runners, install the Noto CJK fonts before building. Make sure to install fonts before running playwright install:

yaml
- name: Install CJK fonts
  run: sudo apt-get install -y fonts-noto-cjk

- name: Install Playwright browsers
  run: pnpm exec playwright install chromium --with-deps

Use web fonts ​

Alternatively, configure your slides to use a web font that supports your language. Slidev will wait for all web fonts to finish loading before capturing the screenshot.

md
---
fonts:
  sans: Noto Sans JP
---

TIP

You can commit the generated og-image.png to your repository. Slidev will reuse the committed image instead of re-generating it on every build, which avoids the font issue entirely and speeds up your CI.

Released under the MIT License.