Adding Social Link Previews

Why Social Headers

Pros - allows students and learning participants to see a preview of the site they will goto when they click on a link. This dramatically increases click-through rates.

Cons - requires an image card be created for each page on your website. As your sites get larger, these images can take up disk space. Publishing your site also takes longer.

Modifying Your mkdocs.yml

plugins:
  - social

How It Works

For each of your Markdown pages, the mkdocs-material build system creates an image. THis image is linked in the HTML header as a

The Cache:

Testing Your Social Media Previews

There are many sites that will check for meta information in your HTML file.

Metatags.io

Open Graph Open Graph This Site

Social Share Preview

Override Test

Claud Override Trials and Final Plugin