Statamic Peak SEO

https://github.com/studio1902/statamic-peak-seo
Admin
An addon for Statamic Peak that provides a full professional SEO toolset for website optimization.
Tokens:39,223
Snippets:479
Trust Score:7.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Single Site Endpoint Examples

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Examples of GET requests for various endpoints in a single-site Statamic installation.

```http
GET https://example.com/robots.txt
GET https://example.com/sitemaps.xml
GET https://example.com/sitemap.xml
GET https://example.com/social-images/entry-id
```

--------------------------------

### Multi-Domain Endpoint Examples

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Examples of GET requests for robots.txt across different domains within a multi-domain Statamic setup.

```http
GET https://example.com/robots.txt
GET https://example.fr/robots.txt
GET https://example.de/robots.txt
```

--------------------------------

### Multi-Site Support Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Demonstrates how the social images route can be accessed across different sites in a multi-site Statamic setup.

```http
https://en.example.com/social-images/entry-id
```

```http
https://fr.example.com/social-images/entry-id
```

--------------------------------

### Multi-Site Sitemap URL Examples

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Examples of how to access sitemaps for different sites in a multi-site Statamic installation. Each site has its own sitemap accessible via its respective URL.

```text
https://example.com/en/sitemap.xml      # English site sitemap
https://example.com/fr/sitemap.xml      # French site sitemap
https://example.com/de/sitemap.xml      # German site sitemap
```

--------------------------------

### Install Statamic Peak SEO Addon

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/README.md

Use this command to manually install the Statamic Peak SEO addon on an older Statamic Peak installation. Ensure you link the SEO fieldsets afterward.

```bash
composer require studio1902/statamic-peak-seo
```

--------------------------------

### Multi-Site (3 Languages) Endpoint Examples

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Examples of GET requests for various endpoints across multiple language sites within a Statamic installation.

```http
GET https://example.com/robots.txt           # Default site
GET https://example.com/en/robots.txt        # English site
GET https://example.com/fr/robots.txt        # French site

GET https://example.com/sitemaps.xml
GET https://example.com/en/sitemap.xml
GET https://example.com/fr/sitemap.xml

GET https://example.com/social-images/id
GET https://example.com/en/social-images/id
GET https://example.com/fr/social-images/id
```

--------------------------------

### Sitemap Index XML Example (Single Site)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Example of the XML content for the sitemap index endpoint in a single-site installation. It includes a single sitemap entry.

```xml
<sitemap>
  <loc>https://example.com/sitemap.xml</loc>
</sitemap>
```

--------------------------------

### Sitemap Index XML Example (Multi-Site)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Example of the XML content for the sitemap index endpoint in a multi-site installation. It includes separate sitemap entries for each configured site.

```xml
<sitemap>
  <loc>https://example.com/sitemap.xml</loc>
</sitemap>
<sitemap>
  <loc>https://example.com/en/sitemap.xml</loc>
</sitemap>
<sitemap>
  <loc>https://example.com/fr/sitemap.xml</loc>
</sitemap>
```

--------------------------------

### Robots.txt Example Content

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

An example of custom content that can be used for the robots.txt file, including user-agent directives and disallow/allow rules.

```text
User-agent: *
Disallow: /admin
Disallow: /api
Allow: /public

User-agent: GPTBot
Disallow: /
```

--------------------------------

### Global Configuration File

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/configuration.md

Example of a general configuration global set in Statamic.

```yaml
title: Configuration
hide: false
fields:
  # General configuration fields
```

--------------------------------

### GET /sitemaps.xml

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Serves the sitemap index, listing all available sitemaps. This includes the main sitemap and per-site sitemaps for multi-site installations. Configuration is controlled by sitemap settings in the 'seo' global set.

```APIDOC
## GET /sitemaps.xml

### Description
Serves the sitemap index listing all available sitemaps.

### Method
GET

### Endpoint
/sitemaps.xml

### Response
XML sitemap index format listing the main sitemap and per-site sitemaps for multi-site installations.

### Configuration
Controlled by sitemap settings in the `seo` global set (enable/disable, update frequency).

### Usage
```bash
curl https://example.com/sitemaps.xml
```
```

--------------------------------

### Sitemap Index XML Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Example of the XML content for the sitemap index endpoint. This lists all available sitemaps for the site(s) and respects multi-site configurations.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>https://example.com/sitemap.xml</loc>
    <lastmod>2026-07-07T10:30:00Z</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://example.com/en/sitemap.xml</loc>
    <lastmod>2026-07-07T10:30:00Z</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://example.com/fr/sitemap.xml</loc>
    <lastmod>2026-07-07T10:30:00Z</lastmod>
  </sitemap>
</sitemapindex>
```

--------------------------------

### Environment Variable Examples for Social Image Generation

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/configuration.md

Examples of how to configure social image generation settings using environment variables in a .env file. These variables allow customization of paths, formats, quality, and queueing.

```bash
# .env file

# Chrome/Chromium path (required for most environments)
SOCIAL_IMAGE_CHROME_PATH=/usr/bin/google-chrome
# or for Chromium:
SOCIAL_IMAGE_CHROME_PATH=/usr/bin/chromium-browser

# Node.js configuration
SOCIAL_IMAGE_NODE_BINARY=/usr/bin/node
SOCIAL_IMAGE_NPM_BINARY=/usr/bin/npm

# Output format and quality
SOCIAL_IMAGE_FORMAT=jpg
SOCIAL_IMAGE_JPG_QUALITY=90

# Queue configuration for async processing
SOCIAL_IMAGE_QUEUE_NAME=images

# Custom screenshot dimensions (for non-standard OG images)
SOCIAL_IMAGE_RESOLUTION=1200x630

# HTML element to capture (must have this ID in the template)
SOCIAL_IMAGE_SELECTOR_ID=og-image
```

--------------------------------

### Global SEO Configuration

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/configuration.md

Example of a global set configuration for SEO settings in Statamic.

```yaml
title: SEO
hide: false
fields:
  # Fields defined here, similar to fieldset definitions
```

--------------------------------

### Robots.txt Content Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Example of the plain text content served by the robots.txt endpoint. This is dynamically generated based on SEO global configuration.

```text
User-agent: *
Disallow: /admin
Disallow: /api
Allow: /public

User-agent: GPTBot
Disallow: /

Sitemap: https://example.com/sitemap.xml
```

--------------------------------

### Sitemap XML Response Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

This is an example of the XML sitemap format returned by the endpoint. It lists URLs with their last modification date, change frequency, and priority.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://example.com/blog/first-post</loc>
    <lastmod>2026-06-15T08:30:00Z</lastmod>
    <changefreq>weekly</changefreq>
    <priority>0.8</priority>
  </url>
  <url>
    <loc>https://example.com/pages/about</loc>
    <lastmod>2026-05-20T14:45:00Z</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.7</priority>
  </url>
</urlset>
```

--------------------------------

### Regex Pattern Examples

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/tags.md

Provides examples of valid regex patterns used for matching URLs in redirect rules. These patterns are evaluated using PHP's preg_match() function.

```php
// Regex patterns must be wrapped in # delimiters:
#^/blog/
#^/old-products/.*#
```

--------------------------------

### Site Verifications Structure Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Provides the structure for site verification codes, specifying the service and the corresponding verification code. Essential for SEO.

```php
[
    [
        'service' => 'google',
        'code' => 'google-site-verification: abc123...'
    ],
    [
        'service' => 'bing',
        'code' => 'msvalidate.01: xyz789...'
    ],
    [
        'service' => 'pinterest',
        'code' => 'pinterest-site-verification: ...'
    ]
]
```

--------------------------------

### SEO Basic Fields - seo_description Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of a meta description for search results and social sharing. It should be compelling and include target keywords within the display limit.

```text
"Discover 50+ scenic hiking trails in Colorado. From easy day hikes to challenging alpine routes. Download maps, read reviews, and plan your adventure today."
```

--------------------------------

### GET /{current_site}/sitemap.xml

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Serves the sitemap for a specific site in multi-site installations. This endpoint is useful for accessing sitemaps of individual sites when the addon is used in a multi-site Statamic setup.

```APIDOC
## GET /{current_site}/sitemap.xml

### Description
Serves the sitemap for a specific site in multi-site installations. This endpoint is useful for accessing sitemaps of individual sites when the addon is used in a multi-site Statamic setup.

### Method
GET

### Endpoint
`/{current_site}/sitemap.xml`

### Parameters
#### Path Parameters
- **current_site** (string) - Required - Statamic site handle

### Response
Same format as main sitemap, but only includes URLs for the specified site.

### Configuration
Same as main sitemap, but respects the specified site's configuration.

### Multi-Site Example
```
https://example.com/en/sitemap.xml      # English site sitemap
https://example.com/fr/sitemap.xml      # French site sitemap
https://example.com/de/sitemap.xml      # German site sitemap
```

### Hreflang Support
Can include hreflang tags if configured in the `seo` global set.
```

--------------------------------

### Multi-Site Social Image URLs

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Examples of URLs for accessing social images in a multi-site Statamic installation. Ensure the site handle and entry ID are correctly specified.

```text
https://example.com/en/social-images/entry-id
https://example.com/fr/social-images/entry-id
```

--------------------------------

### Robots.txt Content Migration Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/updates.md

Illustrates the transformation of a static robots.txt file to the format stored in the SEO global set. The 'Sitemap:' directive is automatically handled and not included in the managed content.

```text
# Before (public/robots.txt)
User-agent: *
Disallow: /admin
Allow: /public
Sitemap: https://example.com/sitemap.xml

# After (seo global set - robots field)
User-agent: *
Disallow: /admin
Allow: /public

# Note: Sitemap directive is removed and will be added automatically
```

--------------------------------

### No Match Behavior Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/tags.md

Shows how the tag behaves when no redirect rule matches the current request. The content within the tag pair will not render.

```antlers
{{ peak_seo_find_redirect_rule :redirect_data="redirects_data" }}
  <!-- This block will not render if no redirect rule matches -->
{{ /peak_seo_find_redirect_rule }}
```

--------------------------------

### Get Sitemap Configuration Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve settings for sitemap generation, including an enable/disable flag and the change frequency for sitemap entries.

```php
$seo->get('use_sitemap')              // boolean - enable/disable sitemaps
$seo->get('sitemap_change_frequency') // string - always|hourly|daily|weekly|monthly|yearly|never
```

--------------------------------

### Get Indexing Defaults

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve environment-specific and collection-specific indexing settings. Use these to control search engine indexing behavior.

```php
// Environment defaults (per environment)
$seo->get('seo_noindex_staging')      // boolean - noindex in staging
$seo->get('seo_noindex_production')   // boolean - index in production

// Collection defaults (array)
$seo->get('indexing_defaults_collections') // Array of collection defaults
```

--------------------------------

### Usage Example for ErrorPage Handler

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/handlers.md

Demonstrates how to register error page handlers in a service provider or route file. Shows configuration for 404, 500, and 503 error pages.

```php
// Register in a service provider or route file

use Studio1902\PeakSeo\Handlers\ErrorPage;

// Set up 404 error page with entry content
ErrorPage::handle404AsEntry();

// Set up generic error page with entry content
ErrorPage::handleErrorPageAsEntry(500, 'errors.500');

// Multiple views can be targeted
ErrorPage::handleErrorPageAsEntry(
    503,
    ['errors.503', 'layout']
);
```

--------------------------------

### SEO Basic Fields - seo_title Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of a custom page title for search engine results and browser tabs. It should be optimized for display length.

```text
"Hiking Trails in Colorado | Peak Adventures"
```

--------------------------------

### Get Cookie Notice Configuration

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve the type and reference for the cookie notice. Supports 'none', 'entry', or 'pdf' types, linking to specific content.

```php
$configuration->get('cookie_notice_type')   // 'none'|'entry'|'pdf'
$configuration->get('cookie_notice_entry')  // Entry reference (if type='entry')
$configuration->get('cookie_notice_asset')  // Asset reference (if type='pdf')
```

--------------------------------

### Get Dynamic Robots.txt Content

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve the raw string content for the dynamic robots.txt file. This allows for custom directives.

```php
$seo->get('robots') // string - raw robots.txt content
```

--------------------------------

### Consent Types Structure Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Defines the structure for consent categories, including name, label, description, and default enabled status. Used for granular consent management.

```php
[
    [
        'name' => 'analytics',
        'label' => 'Analytics',
        'description' => 'Help us understand how you use our site',
        'enabled_by_default' => false
    ],
    [
        'name' => 'marketing',
        'label' => 'Marketing',
        'description' => 'Track your journey for targeted ads',
        'enabled_by_default' => false
    ],
    [
        'name' => 'preferences',
        'label' => 'Preferences',
        'description' => 'Remember your choices',
        'enabled_by_default' => true
    ]
]
```

--------------------------------

### Error Page Entry Format Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Shows the format for referencing error page entries, combining collection handle and entry ID. Ensures correct error page display.

```php
'blog/my-not-found-page'  // collection_handle/entry_id
```

--------------------------------

### Dispatch GenerateSocialImagesJob

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/jobs.md

Example of how to dispatch the GenerateSocialImagesJob for a given Statamic entry. The job can be configured to run on a specific queue using the queue name from the SEO configuration.

```php
use Studio1902\PeakSeo\Jobs\GenerateSocialImagesJob;
use Statamic\Facades\Entry;

// Get an entry
$entry = Entry::find('some-id');

// Dispatch the job
GenerateSocialImagesJob::dispatch($entry)
    ->onQueue(config('statamic-peak-seo.social_image.queue_name'));

// The job will:
// 1. Request https://example.com/social-images/{entry-id}
// 2. Capture the element with id="og"
// 3. Save it as social_images/title-og-{timestamp}.png
// 4. Attach the asset to the entry's og_image field
```

--------------------------------

### GET /robots.txt

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Serves the dynamically generated robots.txt file, which includes User-Agent rules, Disallow/Allow directives, and the sitemap URL. Content is managed via the 'seo' global set.

```APIDOC
## GET /robots.txt

### Description
Serves the dynamically generated robots.txt file.

### Method
GET

### Endpoint
/robots.txt

### Response
Plain text robots.txt format with User-Agent rules, Disallow/Allow directives, and Sitemap URL.

### Configuration
Content is managed in the `seo` global set under the `robots` field.

### Usage
```bash
curl https://example.com/robots.txt
```
```

--------------------------------

### Redirect Rule Structure Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Defines the structure for individual redirect rules, including old URL (or regex), new URL, HTTP response code, and enabled status. Supports exact URLs and regex patterns.

```php
[
    [
        'url_old' => '/old-page',
        'url_new' => '/new-page',
        'response' => '301',
        'enabled' => true
    ],
    [
        'url_old' => '#^/blog/2024/.*#',
        'url_new' => '/archive/2024',
        'response' => '301'
    ]
]
```

--------------------------------

### GenerateSocialImages Usage Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/actions.md

Illustrates how the GenerateSocialImages action is registered and utilized within the Statamic CP for bulk operations on entries, enabling asynchronous OG image generation.

```php
// This action is registered in the Statamic Peak SEO ServiceProvider
// and becomes available in the Statamic CP for bulk operations on entries.

// Users with edit permission can select multiple entries
// from collections configured for social image generation
// and dispatch the action to generate OG images asynchronously.
```

--------------------------------

### GET /social-images/{id}

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Renders the social image template for a specific entry, intended for server-side screenshotting.

```APIDOC
## GET /social-images/{id}

### Description
Renders the social image template for a specific entry.

### Method
GET

### Endpoint
/social-images/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Entry ID

### Response
#### Success Response (200)
HTML page containing the social image preview with an element with `id="og"` (or configured selector).

### Configuration
- Selector to capture: `SOCIAL_IMAGE_SELECTOR_ID` (default: `og`)
- Resolution: `SOCIAL_IMAGE_RESOLUTION` (default: `1200x630`)
- Format: `SOCIAL_IMAGE_FORMAT` (default: `png`)

### Access Control
This route is public and used by server-side image generation only. It should not need authentication.
```

--------------------------------

### Open Graph Type Meta Tag Output Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Illustrates how the 'og_type' field is rendered as an HTML meta tag for Open Graph.

```html
<meta property="og:type" content="article">
```

--------------------------------

### GET Request for Sitemap

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Use this endpoint to retrieve the XML sitemap for your site. It is publicly accessible and does not require authentication.

```http
GET /sitemap.xml
```

```http
GET /{site_handle}/sitemap.xml
```

--------------------------------

### Get Consent Banner Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve boolean for showing the consent banner and an array of consent categories. Used to configure GDPR consent.

```php
$seo->get('use_consent_banner')   // boolean - show consent banner
$seo->get('consent_types')        // array of consent categories
```

--------------------------------

### Get Hreflang Configuration Setting

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve a boolean flag to enable or disable the generation of hreflang tags for multi-language canonical relationships.

```php
$seo->get('use_hreflang')  // boolean - enable hreflang tags
```

--------------------------------

### Register Multi-Site Sitemap Route

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Register a sitemap route that dynamically handles different sites in a multi-site Statamic installation. The {current_site} parameter ensures the correct sitemap is served based on the URL.

```php
Route::statamic(
    URL::tidy('{current_site}/sitemap.xml'),
    'statamic-peak-seo::sitemap/sitemap',
    ['layout' => null, 'content_type' => 'application/xml']
);
```

--------------------------------

### Redirect Rule Structure Example

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/tags.md

Defines the expected structure for individual redirect rules within the 'redirects' array. Both 'url_old' and 'url_new' are required. The 'response' field is optional and defaults to 301.

```php
[
    'url_old' => '/old-path',
    'url_new' => '/new-path',
    'response' => '301',
    'response' => ['value' => '301'],
    // ... other fields
]
```

--------------------------------

### XML Sitemap URL Pattern

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

This is an example of the XML sitemap format. It includes URLs for published collection entries, taxonomy terms, and static pages, respecting various SEO configurations.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://example.com/path</loc>
    <lastmod>2026-07-07T10:30:00Z</lastmod>
    <priority>0.8</priority>
    <changefreq>weekly</changefreq>
  </url>
</urlset>
```

--------------------------------

### GET /sitemap.xml

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Serves the main sitemap for the default site. This includes URLs for published collection entries, taxonomy terms, and static pages, respecting various indexing configurations.

```APIDOC
## GET /sitemap.xml

### Description
Serves the main sitemap for the default site. This includes URLs for published collection entries, taxonomy terms, and static pages, respecting various indexing configurations.

### Method
GET

### Endpoint
/sitemap.xml

### Response
XML sitemap format with URLs for:
- Published collection entries
- Published taxonomy terms
- Static pages (if configured)

### Configuration
Includes URLs based on:
- Global `seo_noindex` setting per collection/taxonomy
- Per-entry/term `seo_noindex` setting (overrides collection default)
- Environment-specific indexing defaults
- Sitemap update frequency from global settings

### URL Patterns
```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://example.com/path</loc>
    <lastmod>2026-07-07T10:30:00Z</lastmod>
    <priority>0.8</priority>
    <changefreq>weekly</changefreq>
  </url>
</urlset>
```

### Multi-Site Support
Generates separate sitemap for default site. Each site gets its own sitemap at `/{site}/sitemap.xml`.
```

--------------------------------

### Get JSON-LD Configuration Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve boolean flags for enabling JSON-LD structured data features like breadcrumbs and knowledge graphs, along with organization details.

```php
$seo->get('use_json_ld_breadcrumbs')    // boolean
$seo->get('use_json_ld_knowledge_graph') // boolean

// Knowledge graph (organization) details
$seo->get('json_ld_organization_name')    // string
$seo->get('json_ld_organization_url')     // string
$seo->get('json_ld_organization_logo')    // asset
```

--------------------------------

### setupBrowsershot Method

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/jobs.md

Configures and returns a Browsershot instance with settings derived from the entry and global SEO configuration. This includes URL, sandbox mode, and binary paths.

```php
protected function setupBrowsershot(): Browsershot
```

--------------------------------

### Get Analytics Tracking Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve settings for various analytics platforms (Google, Plausible, Umami), including enable flags, IDs, domains, and website IDs.

```php
// Google Analytics
$seo->get('use_google_analytics')      // boolean
$seo->get('google_analytics_id')       // string - GA4 measurement ID

// Plausible Analytics
$seo->get('use_plausible_analytics')   // boolean
$seo->get('plausible_analytics_domain')// string - domain to track

// Umami Analytics
$seo->get('use_umami_analytics')       // boolean
$seo->get('umami_analytics_website_id')// string - website ID
$seo->get('umami_analytics_script_src')// string - script URL

// Environment-specific
$seo->get('tracker_environments')      // array of environment settings
```

--------------------------------

### bootAddon()

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Called during addon bootstrap to register publishable fieldsets, views, and load language files.

```APIDOC
## bootAddon()

**Description:** Called during addon bootstrap after the application is fully booted.

**Actions:**
1. Registers publishable fieldsets
2. Registers publishable views
3. Loads language files from `resources/lang`
```

--------------------------------

### Get Social Media Fallback Values

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve fallback assets and strings for open graph images and descriptions, used when specific tags are not provided.

```php
$seo->get('og_image_fallback')        // asset - default OG image
$seo->get('og_description_fallback')  // string - default OG description
```

--------------------------------

### Get Privacy Policy Entry Reference

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve the entry reference for the privacy policy. Links to the dedicated privacy policy page for user information.

```php
$configuration->get('privacy_policy_entry') // Entry reference to privacy policy
```

--------------------------------

### HTML Meta Tag for Follow (Default)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the meta tag when the 'seo_nofollow' toggle is off, which is the default behavior. This allows search engines to follow links on the page.

```html
<meta name="robots" content="follow">
```

--------------------------------

### bootAddon Method - PeakSeoServiceProvider

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

The main bootstrap method called after the application is fully booted. It registers publishable assets and loads language files.

```php
public function bootAddon()
```

--------------------------------

### Get Error Page Entry References

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve entry references for 404 and 500 error pages. Used to specify custom content for error pages.

```php
$configuration->get('error_404_entry')  // Entry reference for 404 errors
$configuration->get('error_500_entry')  // Entry reference for 500 errors
```

--------------------------------

### Register Robots.txt Route

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Register a custom route for robots.txt using Statamic's Route::statamic() helper. This example sets the content type to plain text and disables layout wrapping.

```php
Route::statamic(URL::tidy('/robots.txt'), 'statamic-peak-seo::robots/robots', [
    'layout' => null,
    'content_type' => 'text/plain',
]);
```

--------------------------------

### GET /{current_site}/social-images/{id}

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Renders the social image template for a specific entry on a specific site. This route is useful for generating social media preview images dynamically.

```APIDOC
## GET /{current_site}/social-images/{id}

### Description
Renders the social image template for a specific entry on a specific site.

### Method
GET

### Endpoint
`/{current_site}/social-images/{id}`

### Parameters
#### Path Parameters
- **current_site** (string) - Required - Statamic site handle
- **id** (string) - Required - Entry ID

### Response
#### Success Response (200)
- The response content type is `text/html`.
- The response is the same as the main social image route, but for the specified site.

### Multi-Site Example
```
https://example.com/en/social-images/entry-id
https://example.com/fr/social-images/entry-id
```
```

--------------------------------

### Get Social Image Generation Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve settings for auto-generating social media open graph images, including enabling the feature, specifying collections, and an option to disable the Chrome sandbox.

```php
$seo->get('use_social_image_generation')  // boolean - enable/disable
$seo->get('social_images_collections')    // array of collection handles

// Advanced option (disable Chrome sandbox for certain environments)
$seo->get('use_no_sandbox_for_social_image_generation') // boolean
```

--------------------------------

### ServiceProvider Architecture

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/overview.md

Illustrates the service provider pattern used by the addon, showing its various components like Actions, Tags, Routes, and more.

```text
ServiceProvider (bootstrap)
├── Actions (GenerateSocialImages)
├── Tags (PeakSeoFindRedirectRule)
├── Routes (robots.txt, sitemaps, social images)
├── Update Scripts (data migrations)
├── Fieldsets (CP form definitions)
└── Views (templates)
```

--------------------------------

### Route Registration for Robots.txt

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Demonstrates how to register the robots.txt route using Statamic's Route::statamic() helper in `routes/web.php`.

```APIDOC
## Route Registration for Robots.txt

Routes are defined in `routes/web.php` using Statamic's `Route::statamic()` helper:

```php
Route::statamic(URL::tidy('/robots.txt'), 'statamic-peak-seo::robots/robots', [
    'layout' => null,
    'content_type' => 'text/plain',
]);
```

### Parameters

| Parameter      | Value | Purpose                       |
|----------------|-------|-------------------------------|
| `layout`       | `null`| No layout wrapper, serve content directly |
| `content_type` | varies| Set response Content-Type header |

### URL Normalization

The `URL::tidy()` helper ensures URLs are:
- Properly formatted with slashes
- Consistent across single and multi-site installations
- Cacheable and SEO-friendly
```

--------------------------------

### Fetch sitemaps.xml

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Use this command to retrieve the sitemap index file, which lists all available sitemaps for your Statamic site. This is crucial for search engine indexing.

```bash
curl https://example.com/sitemaps.xml
```

--------------------------------

### Publish Specific Assets using Service Provider

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Allows publishing of specific assets like fieldsets or views by referencing the addon's service provider.

```bash
# Publish only fieldsets
php artisan vendor:publish --provider="Studio1902\PeakSeo\ServiceProvider" --tag=fieldsets

# Publish only views
php artisan vendor:publish --provider="Studio1902\PeakSeo\ServiceProvider" --tag=views
```

--------------------------------

### GenerateSocialImages run() Method

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/actions.md

Executes the action by dispatching a GenerateSocialImagesJob for each selected entry. The return message varies based on whether the sync or async queue driver is used.

```php
public function run($items, $values): string
```

--------------------------------

### Generate Static Files with Artisan

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/endpoints.md

Use this command to generate static files for high-traffic sites. This serves content from the static directory, improving performance and SEO.

```bash
# Generate static files
php artisan statamic:static:generate
```

--------------------------------

### HTML Canonical Link Tag (Current Type)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the canonical link tag when 'seo_canonical_type' is 'current'. This points to the canonical URL on the same domain.

```html
<link rel="canonical" href="https://original-domain.com/page">
```

--------------------------------

### GenerateSocialImages Constructor

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/actions.md

Initializes the action by checking SEO global configuration to enable social image generation for specific collections. It sets the `$available_collections` property based on these settings.

```php
public function __construct()
```

--------------------------------

### Web Routes

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Loads web routes from `routes/web.php`, including dynamic generation of robots.txt, sitemaps, and social images.

```APIDOC
## Web Routes

### `/robots.txt`

**Purpose:** Serve dynamically generated robots.txt
**Content Type:** `text/plain`
```

```APIDOC
### `/sitemaps.xml`

**Purpose:** Serve sitemap index
**Content Type:** `application/xml`
```

```APIDOC
### `/sitemap.xml`

**Purpose:** Serve main sitemap
**Content Type:** `application/xml`
```

```APIDOC
### `/{current_site}/sitemap.xml`

**Purpose:** Site-specific sitemap
**Content Type:** `application/xml`
```

```APIDOC
### `/social-images/{id}`

**Purpose:** Render social image template
**Content Type:** `text/html`
```

```APIDOC
### `/{current_site}/social-images/{id}`

**Purpose:** Site-specific social image template
**Content Type:** `text/html`
```

--------------------------------

### Get Redirect Rules Data

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve an array of redirect rules from the configuration. Used to manage URL redirects for SEO and user experience.

```php
$configuration->get('redirects_data') // array of redirect rules
```

--------------------------------

### Multi-Site Routing for Sitemap

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Shows how to configure multi-site routing for the sitemap.xml endpoint using the `{current_site}` parameter.

```APIDOC
## Multi-Site Routing for Sitemap

For multi-site installations, routes can include the `{current_site}` parameter:

```php
Route::statamic(
    URL::tidy('{current_site}/sitemap.xml'),
    'statamic-peak-seo::sitemap/sitemap',
    ['layout' => null, 'content_type' => 'application/xml']
);
```

This automatically resolves to:
- `/en/sitemap.xml` for the English site
- `/fr/sitemap.xml` for the French site
- etc.
```

--------------------------------

### HTML Canonical Link Tag (External Type)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the canonical link tag when 'seo_canonical_type' is 'external'. This points to an external URL as the canonical source.

```html
<link rel="canonical" href="https://external-site.com/page">
```

--------------------------------

### Exact URL Matching Logic

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/tags.md

Demonstrates the exact string comparison logic used for matching URLs, including how trailing slashes are handled and the root path is processed.

```php
// Matches these pairs (with matching results):
'/old-path'   === '/old-path'          // Matches
'/old-path/'  === '/old-path'          // Matches (trailing slash removed)
'/old-path'   === '/old-path/'         // Matches (trailing slash removed)
'/'           === '/'                  // Matches
```

--------------------------------

### HTML Meta Tag for Nofollow

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the meta tag applied when the 'seo_nofollow' toggle is turned on. This instructs search engines not to follow links on the page.

```html
<meta name="robots" content="nofollow">
```

--------------------------------

### Configure Social Image Generation

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/overview.md

Set environment variables to control the format, quality, dimensions, and paths for social image generation.

```bash
SOCIAL_IMAGE_FORMAT=png
SOCIAL_IMAGE_JPG_QUALITY=100
SOCIAL_IMAGE_RESOLUTION=1200x630
SOCIAL_IMAGE_CHROME_PATH=/usr/bin/chrome
SOCIAL_IMAGE_NODE_BINARY=/usr/bin/node
SOCIAL_IMAGE_NPM_BINARY=/usr/bin/npm
SOCIAL_IMAGE_QUEUE_NAME=default
SOCIAL_IMAGE_SELECTOR_ID=og
```

--------------------------------

### HTML Meta Tag for Noindex

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the meta tag generated when the 'seo_noindex' field is set to 'noindex'. This instructs search engines not to index the page.

```html
<meta name="robots" content="noindex">
```

--------------------------------

### Global Configuration for Indexing Tab

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/updates.md

This YAML snippet illustrates the structure of the 'Indexing' tab in the global SEO configuration after the MigrateNoindexToButtonGroup update, including sections for environments, collections, and taxonomies.

```yaml
tabs:
  indexing:
    display: 'Indexing'
    sections:
      - display: 'Environments'
        instructions: 'When to noindex and nofollow by default.'
        fields:
          - import: statamic-peak-seo::globals_seo_page_environments
      - display: 'Collections'
        instructions: 'Set default indexing behavior per collection...'
        fields:
          - import: statamic-peak-seo::globals_seo_indexing_collections
      - display: 'Taxonomies'
        instructions: 'Set default indexing behavior per taxonomy...'
        fields:
          - import: statamic-peak-seo::globals_seo_indexing_taxonomies
```

--------------------------------

### Get Consent Cookie Settings

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve settings for consent cookies, including the cookie name and its expiry duration in days. Configures how consent is stored.

```php
$seo->get('consent_cookie_name')  // string - cookie name to set
$seo->get('consent_expiry_days')  // integer - how long cookie lasts
```

--------------------------------

### Handle Various HTTP Status Codes with Entry Content

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/handlers.md

Illustrates configuring different HTTP status codes to use entry-based content for their respective error pages. This provides flexibility in managing error page content dynamically.

```php
ErrorPage::handleErrorPageAsEntry(400, 'errors.bad_request');
ErrorPage::handleErrorPageAsEntry(401, 'errors.unauthorized');
ErrorPage::handleErrorPageAsEntry(403, 'errors.forbidden');
ErrorPage::handleErrorPageAsEntry(404, 'errors.not_found');
ErrorPage::handleErrorPageAsEntry(500, 'errors.server_error');
ErrorPage::handleErrorPageAsEntry(503, 'errors.service_unavailable');
```

--------------------------------

### HTML Canonical Link Tag (Entry Type)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the canonical link tag when the 'seo_canonical_type' is set to 'entry'. This points to the current entry's URL.

```html
<link rel="canonical" href="https://example.com/page">
```

--------------------------------

### Check Social Image Generation Action Availability in PHP

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/overview.md

Instantiate the `GenerateSocialImages` action class and check its visibility for a given entry.

```php
use Studio1902\PeakSeo\Actions\GenerateSocialImages;

// Check action availability
$action = new GenerateSocialImages();
$visible = $action->visibleTo($entry);
```

--------------------------------

### HTML Meta Tag for Index

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Example of the meta tag generated when the 'seo_noindex' field is set to 'index'. This explicitly tells search engines to index the page.

```html
<meta name="robots" content="index">
```

--------------------------------

### Get Site Verifications

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve an array of site verification codes for search engines. Used to prove ownership of your site to services like Google and Bing.

```php
$seo->get('site_verifications')  // array of verification codes
```

--------------------------------

### Publish Statamic Peak SEO Assets

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/overview.md

Use Artisan commands to publish the package's fieldsets and views for customization.

```bash
php artisan vendor:publish --tag=statamic-peak-seo-fieldsets
```

```bash
php artisan vendor:publish --tag=statamic-peak-seo-views
```

--------------------------------

### Fetch robots.txt

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/routes.md

Use this command to retrieve the dynamically generated robots.txt file from your Statamic site. This file contains directives for web crawlers.

```bash
curl https://example.com/robots.txt
```

--------------------------------

### Statamic Peak SEO File Structure

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/README.md

This outlines the directory structure for the Statamic Peak SEO addon, including the location of README, configuration, API reference, and other essential files.

```bash
```
/output/
├── README.md                          # This file
├── INDEX.md                          # Complete navigation index
├── overview.md                       # Project overview & architecture
├── configuration.md                  # All configuration options
├── types.md                         # Data structures & schemas
├── entry-fields.md                  # SEO entry field definitions
├── endpoints.md                      # HTTP routes & responses
├── routes.md                        # Route registration details
│
└── api-reference/
    ├── service-provider.md          # ServiceProvider registration
    ├── actions.md                   # GenerateSocialImages action
    ├── jobs.md                      # GenerateSocialImagesJob job
    ├── tags.md                      # PeakSeoFindRedirectRule tag
    ├── handlers.md                  # ErrorPage handler
    └── updates.md                   # All migration scripts (v1.5 to v11.3)
```
```

--------------------------------

### Asset Reference Format

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Asset references are stored as their UUID. Use the Asset::find() method to retrieve an asset object and then call the url() method to get its URL.

```php
// Asset stored as asset ID
'asset-uuid-here'

// Access as
$asset = Asset::find($value);
$url = $asset->url();
```

--------------------------------

### Register Publishable Views - PeakSeoServiceProvider

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Registers views that can be published to the project for customization. Use the provided command to publish them to the specified resource path.

```php
protected function registerPublishableViews()
```

--------------------------------

### Configure 404 Error Page with Entry Content

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/handlers.md

Use this method to set up 404 error pages to display content from a Statamic entry. It registers a view composer for the default 404 view.

```php
public static function handle404AsEntry(): void
```

--------------------------------

### Antlers Fallback Description Logic

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/resources/views/snippets/_fallback_description.antlers.html

Use this snippet to get a fallback description for meta and OG tags. It checks collection defaults and applies logic based on the 'fallback' type.

```html
{{# @name Fallback description @desc Get the fallback description for meta and og. #}} {{ seo:collection_defaults | where('collection', {collection}) }} {{ if fallback == 'field' }} {{ scope:field }} {{ field[field_handle] | strip_tags | entities | trim | safe_truncate(157, '...') }} {{ /scope:field }} {{ elseif fallback == 'custom_text' }} {{ custom_text }} {{ elseif fallback == 'page_builder' }} {{ if page_builder:0:text }} {{ if page_builder:0:text | is_array }} {{ page_builder:0:text | raw | where('type', 'paragraph') | bard_text | strip_tags | entities | trim | safe_truncate(157, '...') }} {{ else }} {{ page_builder:0:text | strip_tags | entities | trim | safe_truncate(157, '...') }} {{ /if }} {{ else }} {{ page_builder where="type:article" limit="1" }} {{ if article }} {{ article | raw | where('type', 'paragraph') | bard_text | entities | trim | safe_truncate(157, '...') }} {{ /if }} {{ /page_builder }} {{ /if }} {{ /if }} {{ /seo:collection_defaults }}
```

--------------------------------

### Global SEO Fieldset Structure (YAML)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Outlines the structure for global SEO settings, organizing various SEO configurations into tabs like page titles, indexing, robots, and sitemap.

```yaml
title: SEO Settings
tabs:
  page_titles:
    sections:
      - display: Title Rules
        fields:
          - import: statamic-peak-seo::globals_seo_page_titles
  indexing:
    sections:
      - display: Environments
        fields:
          - import: statamic-peak-seo::globals_seo_page_environments
      - display: Collections
        fields:
          - import: statamic-peak-seo::globals_seo_indexing_collections
  robots:
    sections:
      - display: Robots
        fields:
          - import: statamic-peak-seo::globals_seo_robots
  sitemap:
    sections:
      - display: Sitemap
        fields:
          - import: statamic-peak-seo::globals_seo_sitemap
```

--------------------------------

### Add Reject All Translation String

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/updates.md

This snippet shows the 'Before' and 'After' state of a language file when the AddRejectAll update script is applied, adding the 'consent_reject_all' translation.

```php
// Before
'consent_ads' => 'Marketing and Advertising',

// After
'consent_reject_all' => 'Reject all',
'consent_ads' => 'Marketing and Advertising',
```

--------------------------------

### GenerateSocialImagesJob Constructor

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/jobs.md

Initializes the job with the entry for which to generate a social image. The entry is stored for use in the handle method.

```php
public function __construct($item)
```

--------------------------------

### Get Page Title Manipulation Rules

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Retrieve an array of rules used to manipulate page titles. Each rule specifies a collection, whether it's enabled, and the string to append or prepend.

```php
$seo->get('change_page_title')
```

--------------------------------

### List Applied Statamic Updates

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/updates.md

Use this Artisan command to view a list of all update scripts that have been successfully executed for your Statamic addon.

```bash
php artisan statamic:updates:list
```

--------------------------------

### Basic SEO Template Usage (Antlers)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Render basic SEO meta tags for title and description using Antlers templating. Fallback values are provided if fields are empty.

```antlers
<!-- Basic SEO -->
<title>{{ seo_title ?? title }} - {{ site:name }}</title>
<meta name="description" content="{{ seo_description ?? excerpt }}">
```

--------------------------------

### Register Routes - PeakSeoServiceProvider

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Loads web routes from a specified file. This is used to define custom URL endpoints for the addon, such as sitemaps and robots.txt.

```php
protected $routes = [
    'web' => __DIR__ . '/../routes/web.php',
];
```

--------------------------------

### Display Entry Data in Error View

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/handlers.md

Example of how to access injected entry data within an Antlers error view template. Shows accessing common fields like title and content.

```antlers
<!-- In resources/views/errors/404.antlers.html -->
<h1>{{ title }}</h1>
<p>{{ content }}</p>

<!-- Access any field from the referenced entry -->
{{ seo_title }}
{{ seo_description }}
```

--------------------------------

### Add Robots Tab to SEO Global Blueprint

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/updates.md

This YAML defines the structure for a new 'Robots' tab within the SEO global blueprint, including instructions and a field import for robots.txt configuration.

```yaml
tabs:
  robots:
    display: 'Robots'
    sections:
      - display: 'Robots'
        instructions: 'Configure the robots.txt'
        fields:
          - import: statamic-peak-seo::globals_seo_robots
```

--------------------------------

### Publish Fieldsets Command

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Command to publish the addon's fieldsets to your Statamic project. This makes SEO configuration fieldsets available for use.

```bash
php artisan vendor:publish --tag=statamic-peak-seo-fieldsets
```

--------------------------------

### SEO Basic Fields Configuration

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/configuration.md

Defines basic SEO fields like title and description. These fields are localizable and have specific character limits for search result optimization.

```yaml
seo_title: text
  max_length: 70
  localizable: true
seo_description: text
  max_length: 160
  localizable: true
```

--------------------------------

### Register Publishable Fieldsets - PeakSeoServiceProvider

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Registers fieldsets that can be published to the project. Use the provided command to publish them to the specified resource path.

```php
protected function registerPublishableFieldsets()
```

--------------------------------

### Access Global SEO Variables (Antlers)

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/types.md

Demonstrates how to access global SEO variables like robots, OG image fallback, hreflang usage, and organization name within Antlers templates.

```antlers
{{ seo:robots }}
{{ seo:og_image_fallback }}
{{ seo:use_hreflang }}
{{ seo:json_ld_organization_name }}
```

--------------------------------

### Composer.json Configuration for Statamic Peak SEO

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/api-reference/service-provider.md

Defines the package name, autoloading, Statamic integration, and dependencies for the Statamic Peak SEO addon.

```json
{
    "name": "studio1902/statamic-peak-seo",
    "autoload": {
        "psr-4": {
            "Studio1902\\PeakSeo\": "src"
        }
    },
    "extra": {
        "statamic": {
            "name": "Statamic Peak SEO",
            "description": "Statamic Peak SEO addon"
        },
        "laravel": {
            "providers": [
                "Studio1902\\PeakSeo\\ServiceProvider"
            ]
        }
    },
    "require": {
        "statamic/cms": "^6.0"
    }
}
```

--------------------------------

### Open Graph Description Field Configuration

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/entry-fields.md

Sets up a localizable plain text field for the Open Graph description, intended for social media previews. It defaults to 'seo_description' if not provided.

```yaml
handle: og_description
type: text_plain
localizable: true
listable: false
```

--------------------------------

### Robots.txt Endpoint

Source: https://github.com/studio1902/statamic-peak-seo/blob/main/_autodocs/COMPLETION_SUMMARY.txt

Dynamically generates the robots.txt file.

```APIDOC
## GET /robots.txt

### Description
Dynamically generates the robots.txt file based on configuration.

### Method
GET

### Endpoint
/robots.txt

### Response
#### Success Response (200)
- **content** (string) - The content of the robots.txt file.
```
Tokens:
Raw