Files
MokoSuiteOpenGraph/README.md
T
Jonathan Miller f1c6eb8f6e
Universal: Auto Version Bump / Version Bump (push) Successful in 25s
Universal: Pre-Release / Build Pre-Release (${{ inputs.stability || github.ref_name }}) (push) Successful in 26s
docs: update CHANGELOG and README for v2.0 release
Add all v2.0 features: 11+ JSON-LD types, 6 preview cards, AI
generation, XML sitemap, per-platform images, SEO scoring, PHPUnit
tests, OpenAPI spec, coverage dashboard, custom schema builder.
2026-06-23 13:05:25 -05:00

91 lines
4.7 KiB
Markdown

# MokoSuiteOpenGraph
<!-- VERSION: 01.04.05 -->
Open Graph, Twitter Card, and social sharing meta tag management for Joomla 4/5/6.
## Overview
MokoSuiteOpenGraph gives you full control over how your Joomla content appears when shared on Facebook, Twitter/X, LinkedIn, Discord, WhatsApp, Telegram, and other social platforms. Set custom titles, descriptions, and images per article, menu item, and category — or let the extension auto-generate them from your existing content.
## Features
### Social Meta Tags
- **Open Graph tags** — `og:title`, `og:description`, `og:image`, `og:url`, `og:type`, `og:site_name`, `og:locale`
- **Twitter/X Cards** — Summary and Summary with Large Image card types
- **LinkedIn** — `article:published_time`, `article:modified_time`, `article:author`
- **Discord** — Custom embed color via `theme-color` meta tag
- **Telegram** — `telegram:channel` for link previews
- **Mastodon/Fediverse** — `fediverse:creator` for author attribution (first extension on any CMS)
- **Pinterest** — Rich pin tags: `article:tag`, `product:availability`, `product:price`
- **og:video** — Per-article video URLs with auto MIME type detection (YouTube/Vimeo/direct)
- **Facebook** — `fb:app_id` support, `og:image:width`/`og:image:height` for instant previews
### Content Management
- **Per-article control** — Custom OG fields tab in the article editor
- **Per-menu-item control** — Custom OG fields in the menu item editor
- **Per-category control** — Category-level OG tag overrides
- **Multilingual support** — Per-language OG data with language-aware fallback
- **Auto-generation** — Builds tags from article content, title, and images automatically
- **Site-wide defaults** — Default OG title, description, and image for all pages
### SEO
- **SEO title override** — Custom `<title>` tag per page
- **Meta description** — Per-page meta description control
- **Robots directive** — Per-page noindex/nofollow settings
- **Canonical URL** — Custom canonical URL overrides
- **JSON-LD structured data** — Article, Product, WebPage, BreadcrumbList, Organization, FAQ, HowTo, Event, Recipe, LocalBusiness, VideoObject, and custom schemas
- **SEO content scoring** — 7-check analysis panel with pass/fail indicators in the editor
### Admin Tools
- **Tag manager dashboard** — View and manage all OG records centrally
- **Batch generation** — Auto-generate OG tags for all existing articles
- **CSV import/export** — Bulk manage OG data via CSV files
- **SEO health badges** — Visual indicators for missing descriptions, long titles, noindex
- **Debug links** — Quick links to Facebook Debugger, LinkedIn Inspector, Google Rich Results
- **Live preview** — Real-time Facebook, Twitter/X, LinkedIn, Discord, Mastodon, and Slack card previews in the editor
- **Character count indicators** — Green/yellow/red warnings on OG and SEO text fields
- **OG coverage dashboard** — Coverage percentage and missing field counts
- **AI meta generation** — Generate OG titles and descriptions with Claude or OpenAI
### Developer Features
- **REST API** — Full CRUD via Joomla Web Services (`/api/v1/mokoog/tags`)
- **MokoSuiteShop integration** — Auto-generated OG/JSON-LD for product pages with pricing meta
- **Plugin event** — `onMokoOGAfterRender` for third-party plugins to add custom social tags
- **OG image generator** — Text overlay on template backgrounds with auto-resize to 1200x630
- **Per-platform image resizing** — Twitter 1200x600, Pinterest 1000x1500, WhatsApp 400x400
- **XML sitemap** — Auto-generates sitemap.xml on article save, respects noindex
- **OpenAPI spec** — Full REST API documentation at `openapi.yaml`
- **PHPUnit tests** — 16 unit tests for JsonLdBuilder schema outputs
## Installation
1. Download the latest `pkg_mokoog-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteOpenGraph/releases)
2. In Joomla Administrator → Extensions → Install → Upload Package File
3. All plugins are enabled automatically on install
## Configuration
Navigate to **Extensions → Plugins → System - MokoSuiteOpenGraph** to configure:
- Site name override
- Default OG title and description (site-wide fallback)
- Default fallback image
- Twitter Card type and @username
- Facebook App ID
- Discord embed color
- Telegram channel
- Fediverse/Mastodon creator handle
- LocalBusiness schema (address, phone, hours, geo)
- XML sitemap generation
- AI meta generation (Claude/OpenAI API key)
- Per-platform image resizing
- Auto-generation, image resize, JSON-LD, and description length settings
## License
GPL-3.0-or-later — See [LICENSE](LICENSE) for details.
## Author
[Moko Consulting](https://mokoconsulting.tech) — hello@mokoconsulting.tech