Add Social Media Metadata
Prompt
Add yml metadata to the @docs/sims/projecting-ai/index.md
Include the title, description and image for social media open graph previews using projecting-ai.png in that folder.
Also put the metadata in the main.html but using standardized header metadata tags.
Session Log: Add Social Media Metadata
Date
2025-11-16
Prompt
User requested: "add yml metadata to the @docs/sims/projecting-ai/index.md and include the image for social media preview using projecting-ai.png in that folder. Also put the metadata in the main.html but using header metadata tags"
Actions Taken
1. Updated index.md with YAML Frontmatter
Added YAML metadata to the top of /docs/sims/projecting-ai/index.md:
1 2 3 4 5 | |
Note: User subsequently updated the image paths to:
1 2 | |
2. Updated main.html with HTML Meta Tags
Added comprehensive metadata tags to the <head> section of /docs/sims/projecting-ai/main.html:
Standard Meta Tags
1 2 | |
Open Graph Tags (Facebook)
1 2 3 4 5 6 | |
Twitter Card Tags
1 2 3 4 5 6 | |
3. Additional User Edits
The user also made the following changes: - Updated the subtitle in main.html to include "(METR.org)" attribution - Added a "Return to Documentation" link at the bottom of main.html - Updated image paths in index.md to use absolute paths from site root
Files Modified
/Users/dan/Documents/ws/tracking-ai-course/docs/sims/projecting-ai/index.md/Users/dan/Documents/ws/tracking-ai-course/docs/sims/projecting-ai/main.html
Outcome
Both files now have proper metadata for social media sharing: - index.md: YAML frontmatter for MkDocs Material theme's social plugin - main.html: Standard HTML meta tags including Open Graph and Twitter Card tags
Both files reference projecting-ai.png as the social media preview image, which needs to be created by the user.
Notes
- The metadata follows best practices for social media sharing
- Open Graph tags work for Facebook, LinkedIn, and other platforms
- Twitter Card tags optimize for Twitter/X sharing
- The image reference assumes
projecting-ai.pngwill be created in the same directory