SEO

Overview

Thulite SEO is an official SEO integration package for Thulite websites. It provides comprehensive search engine optimization features through structured data, meta tags, and other SEO best practices.

Installation

Add the package to your Thulite project:

npm install @thulite/seo@latest
pnpm install @thulite/seo@latest
yarn add @thulite/seo@latest
bun install @thulite/seo@latest

Features

Meta tags

  • Title tags
  • Meta descriptions
  • Canonical URLs
  • Robots directives
  • Alternate language links

Open Graph & Twitter cards

  • Social media preview optimization
  • Image, title, and description for sharing

Structured data (JSON-LD)

  • Website schema
  • Organization/Person schema
  • BreadcrumbList schema
  • Article schema
  • BlogPosting schema
  • NewsArticle schema
  • Product schema

Other features

  • Favicon generation
  • Sitemap generation
  • Robots.txt configuration

Configuration

Basic configuration

Add the following to your site configuration:

config/_default/params.toml
# SEO (@thulite/seo)
[seo]
  [seo.title]
    separator = "—"
    suffix = ""
  [seo.favicons]
    icon = "favicon.png" # favicon.png (default)
    svgIcon = "favicon.svg" # favicon.svg (default)
  [seo.schemas]
    type = "Organization" # Organization (default) or Person
    logo = "favicon-512x512.png" # Logo of Organization — favicon-512x512.png (default)
    name = "Thulite" # Name of Organization or Person
    sameAs = ["https://github.com/thuliteio/thulite", "https://x.com/thuliteio", "https://fosstodon.org/@thulite"] # E.g. ["https://github.com/thuliteio/thulite", "https://fosstodon.org/@thulite"]
    images = ["cover-seo.png"] # ["cover.png"] (default)
    article = [] # Article sections
    newsArticle = [] # NewsArticle sections
    blogPosting = [] # BlogPosting sections
    product = [] # Product sections

Page-level configuration

In your content front matter:

---
title: "Your Page Title"
description: "Your page description"
seo:
  title: "Custom SEO Title" # Optional override
  description: "Custom SEO Description" # Optional override
  canonical: "https://example.com/canonical-url" # Optional canonical URL
  robots: "noindex, nofollow" # Optional robots directive
---

Schema types

Website schema

Applied to the homepage automatically.

Organization/Person schema

Applied to the homepage based on your configuration.

Applied to all pages except the homepage.

Content-specific schemas

  • Article: Applied to pages in sections defined in seo.schemas.article
  • BlogPosting: Applied to pages in sections defined in seo.schemas.blogPosting
  • NewsArticle: Applied to pages in sections defined in seo.schemas.newsArticle
  • Product: Applied to pages in sections defined in seo.schemas.product

Credits

This package is based on:

Edit this page on GitHub
Next
Getting Started