loveduckie/silverstripe-social-meta-tags

A Silverstripe module for injecting OpenGraph and Twitter meta tags for sharing and social previews.

5.x-dev 2024-11-21 15:54 UTC

Requires

• silverstripe/admin: ^1.0 | ^2.0
• silverstripe/framework: ^4.0 | ^5.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.0

BSD-3-Clause

• Luc Shelton

• cms
• silverstripe
• silverstripe-4
• social-share
• social-meta-tags
• silverstripe-5

README

silverstripe-social-metadata-tags

Easily enhance your website's social media presence with automated metadata generation.

This SilverStripe module provides a straightforward solution for integrating metadata to ensure seamless sharing previews across social media platforms. The module automatically generates Open Graph, Twitter Card, and other platform-specific metadata tags, ensuring that your website content appears polished and engaging when shared.

Ideal for boosting social media engagement, this module allows you to control the appearance of shared links while being fully customizable and simple to integrate. Improve your website’s visibility and make your links stand out across all major platforms.

Support

Find below some of the features that this module supports.

• ✅ Configurable by page type
  • Inject meta data dependent on page types.
• ✅ Support for OpenGraph protocol
  • Provides complete support for the OpenGraph protocol.
• ✅ Support for Twitter meta data
  • Provides complete support for all Twitter social share tags.

Features

• Automatic Metadata Generation: Supports Open Graph, Twitter Cards, and more.
• Customizable: Easily tailor metadata settings for specific page types and social platforms.
• Platform Compatibility: Ensures your content looks great on Facebook, Twitter, LinkedIn, and Pinterest.
• Developer-Friendly: Simple to install, configure, and extend.

Requirements

• SilverStripe ^4.0
• Yarn, Node.js (6.x or higher), and npm (for building frontend assets)

Installation

Install the module via Composer:

composer require loveduckie/silverstripe-social-meta-tags

Usage

Once installed, the module will automatically generate metadata for your pages based on configurable settings. Refer to the documentation for detailed setup and customization instructions.

Documentation

Comprehensive documentation is available to help you get started and customize the module to fit your needs. See the Documentation README for more information.

License

This module is licensed under a 3-clause BSD license. See the License file for details.

Maintainers

• Luc Shelton [e-mail]

Bug Tracker

Found a bug? Submit an issue via the Issues section of this repository.

Before submitting, please:

1. Search existing issues to avoid duplicates.
2. If it’s a new bug, create a detailed issue describing:
   • Steps to reproduce the issue.
   • Expected outcome vs. actual behavior.
   • Your environment (SilverStripe version, PHP version, OS, installed modules).
   • Screenshots or screencasts, if applicable.

For security-related issues, please contact the maintainers directly instead of creating a public issue.

Contribution Guidelines

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a feature branch for your changes.
3. Submit a pull request (PR) with a clear description of the changes.

Please discuss significant changes with the maintainers before submitting a PR.