README

ArtisanPack UI SEO is a comprehensive SEO management package for Laravel applications. Built on Livewire 3, it provides complete control over meta tags, Open Graph, Twitter Cards, Schema.org markup, XML sitemaps, URL redirects, robots.txt generation, and SEO content analysis.

Quick Start

Installation

# Install the package
composer require artisanpack-ui/seo

# Run migrations
php artisan migrate

# Publish configuration (optional)
php artisan vendor:publish --tag=seo-config

Basic Usage

// Add the HasSeo trait to your model
use ArtisanPackUI\Seo\Traits\HasSeo;

class Post extends Model
{
    use HasSeo;
}

<!-- Render all SEO tags in your layout -->
<head>
    <x-seo-meta :model="$post" />
</head>

Key Features

Meta Tag Management: Title, description, robots directives, and canonical URLs with automatic fallbacks
Social Media Tags: Open Graph for Facebook/LinkedIn and Twitter Cards with image support
Schema.org Markup: 14 built-in JSON-LD schema types for rich search results
Multi-Language Support: Hreflang tags for international SEO
URL Redirects: Exact, regex, and wildcard redirects with hit tracking
XML Sitemaps: Standard, image, video, and news sitemaps with automatic indexing
Dynamic Robots.txt: Configurable rules with bot-specific directives
SEO Analysis: 8 built-in analyzers for content quality scoring
Performance Caching: Comprehensive caching for meta tags, sitemaps, and redirects
Admin Components: Livewire components for visual SEO management

Components

Blade Components

Component	Purpose
`<x-seo-meta>`	All-in-one SEO output (meta, OG, Twitter, schema)
`<x-seo-meta-tags>`	Basic meta tags only
`<x-seo-open-graph>`	Open Graph tags for social sharing
`<x-seo-twitter-card>`	Twitter Card meta tags
`<x-seo-schema>`	Schema.org JSON-LD markup
`<x-seo-hreflang>`	Hreflang link tags for multi-language

Livewire Components

Component	Purpose
`<livewire:seo-meta-editor>`	Full SEO editing interface with tabs
`<livewire:redirect-manager>`	URL redirect management
`<livewire:seo-dashboard>`	SEO overview and statistics
`<livewire:seo-analysis-panel>`	Content analysis results
`<livewire:hreflang-editor>`	Multi-language URL editor
`<livewire:meta-preview>`	Search result preview
`<livewire:social-preview>`	Social share preview

Schema Types

Article, BlogPosting, Product, Organization, Person, LocalBusiness, Event, Recipe, FAQPage, HowTo, BreadcrumbList, WebSite, WebPage, VideoObject

Documentation

Comprehensive documentation is available at docs.artisanpackui.dev:

Getting Started - Quick start guide
Installation - Detailed setup instructions
Configuration - All configuration options
Meta Tags - Meta tag management
Social Media - Open Graph and Twitter Cards
Schema.org - Structured data markup
Components - Blade and Livewire components
API Reference - Models, services, and events

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=seo-config

Key Configuration Options

// config/seo.php
return [
    // Site defaults
    'site' => [
        'name' => env('APP_NAME'),
        'separator' => ' | ',
    ],

    // Default meta values
    'defaults' => [
        'title' => null,
        'description' => null,
        'image' => null,
        'robots' => 'index, follow',
    ],

    // Feature toggles
    'redirects' => ['enabled' => true],
    'sitemap' => ['enabled' => true],
    'robots' => ['enabled' => true],
    'analysis' => ['enabled' => true],

    // Caching
    'cache' => [
        'enabled' => true,
        'driver' => null, // Uses default cache driver
        'ttl' => 3600,
    ],

    // Routes
    'routes' => [
        'sitemap' => true,
        'robots' => true,
    ],
];

Environment Variables

Variable	Description	Default
`SEO_SITE_NAME`	Site name for titles	`APP_NAME`
`SEO_TITLE_SEPARATOR`	Separator between title and site name	`\\|`
`SEO_DEFAULT_ROBOTS`	Default robots directive	`index, follow`
`SEO_CACHE_ENABLED`	Enable SEO caching	`true`
`SEO_CACHE_TTL`	Cache TTL in seconds	`3600`
`SEO_REDIRECTS_ENABLED`	Enable redirect handling	`true`
`SEO_SITEMAP_ENABLED`	Enable sitemap generation	`true`
`SEO_ANALYSIS_ENABLED`	Enable SEO analysis	`true`

Artisan Commands

# Generate XML sitemap
php artisan seo:generate-sitemap

# Submit sitemap to search engines
php artisan seo:submit-sitemap

# Clear SEO cache
php artisan seo:clear-cache

Requirements

PHP 8.2 or higher
Laravel 11 or 12
Livewire 3.6+

Dependencies

This package integrates with the ArtisanPack UI ecosystem:

artisanpack-ui/core - Core utilities
artisanpack-ui/livewire-ui-components - UI components
artisanpack-ui/hooks - WordPress-style hooks for extensibility

Events

The package dispatches events for key actions:

use ArtisanPackUI\Seo\Events\SeoMetaCreated;
use ArtisanPackUI\Seo\Events\SeoMetaUpdated;
use ArtisanPackUI\Seo\Events\SitemapGenerated;
use ArtisanPackUI\Seo\Events\RedirectHit;

// Listen for SEO meta changes
Event::listen(SeoMetaUpdated::class, function ($event) {
    // $event->seoMeta contains the updated meta
    // $event->model contains the associated model
});

// Listen for redirect hits
Event::listen(RedirectHit::class, function ($event) {
    // $event->redirect contains the redirect record
    // $event->request contains the HTTP request
});

Helper Functions

// Get the SEO service
$seo = seo();

// Get SEO meta for a model
$meta = seoMeta($post);

// Format a page title with site name
$title = seoTitle('My Page'); // "My Page | Site Name"

// Truncate description to SEO length
$desc = seoDescription($longText); // Truncated to 160 chars

// Check if a feature is enabled
if (seoIsEnabled('sitemap')) {
    // Generate sitemap
}

// Get configuration value
$separator = seoConfig('site.separator');

Extensibility

Custom Schema Types

use ArtisanPackUI\Seo\Contracts\SchemaBuilderInterface;

class CustomSchemaBuilder implements SchemaBuilderInterface
{
    public function build($model, array $data = []): array
    {
        return [
            '@context' => 'https://schema.org',
            '@type' => 'CustomType',
            // ... custom properties
        ];
    }
}

// Register via service provider
$this->app->bind('seo.schema.custom', CustomSchemaBuilder::class);

Custom Analyzers

use ArtisanPackUI\Seo\Contracts\AnalyzerInterface;

class CustomAnalyzer implements AnalyzerInterface
{
    public function analyze($model): array
    {
        return [
            'score' => 85,
            'status' => 'good',
            'message' => 'Content passes custom analysis.',
            'suggestions' => [],
        ];
    }
}

Filter Hooks

use function addFilter;

// Modify meta tags before output
addFilter('seo.meta_tags', function (array $tags, $model) {
    $tags['custom-meta'] = 'Custom value';
    return $tags;
});

// Add custom sitemap entries
addFilter('seo.sitemap_entries', function (Collection $entries) {
    $entries->push(new CustomSitemapEntry());
    return $entries;
});

Middleware

Add the redirect middleware to handle URL redirects:

// In bootstrap/app.php
->withMiddleware(function (Middleware $middleware) {
    $middleware->web(append: [
        \ArtisanPackUI\Seo\Http\Middleware\HandleRedirects::class,
    ]);
})

Contributing

Contributions are welcome! To contribute:

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add some amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Merge Request

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting merge requests.

License

ArtisanPack UI SEO is open-sourced software licensed under the MIT license.

artisanpack-ui / seo

Maintainers

Details