Skip to content

Meta Tags Configuration

Coming Soon

This detailed guide to meta tags and Open Graph configuration is under development. Master social sharing and search engine optimization.

What This Page Will Cover

This guide will explain:

  • Essential Meta Tags: Title, description, viewport, and more
  • Open Graph Tags: Optimizing for social media sharing
  • Twitter Cards: Enhanced Twitter/X sharing
  • Schema.org: Structured data for rich snippets
  • Custom Meta Tags: Adding application-specific metadata
  • Dynamic Meta Tags: Generating tags based on content

Basic Meta Tags

While this guide is being completed, here are essential meta tags:

<!-- Basic Meta Tags -->
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Your page description">
<meta name="author" content="Your Name">
<meta name="keywords" content="documentation, mkdocs, material">

<!-- Open Graph -->
<meta property="og:title" content="Page Title">
<meta property="og:description" content="Page description">
<meta property="og:image" content="https://example.com/image.jpg">
<meta property="og:url" content="https://example.com/page">
<meta property="og:type" content="article">

<!-- Twitter Card -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="Page Title">
<meta name="twitter:description" content="Page description">
<meta name="twitter:image" content="https://example.com/image.jpg">

MkDocs Configuration

# mkdocs.yml
extra:
  meta:
    - name: 'description'
      content: 'Ultimate MkDocs documentation guide'
    - name: 'author'
      content: 'Documentation Team'

Last updated: December 2024