SEO

SEO metadata, sitemap, robots.txt, and feed generation for Riebeckite.

日本語

Overview

seo() provides a PluginSeoExtension consumed by the Riebeckite app. It builds per-page SEO metadata and renders /sitemap.xml, /robots.txt, and RSS / Atom / JSON feeds.

Usage

import { defineConfig } from "@riebeckite/core";
import { seo } from "@riebeckite/plugin-seo";
 
export default defineConfig({
  // ...
  plugins: [
    seo({
      feed: { rss: true, atom: true, json: true, limit: 30 },
      sitemap: true,
      robots: true,
    }),
  ],
});

Options

Generated metadata

Articles (buildArticleSeo)

• title: "{title} | {site.title}"
• description: frontmatter.description, otherwise the first 160 characters of the post text
• canonicalUrl: frontmatter.canonical, otherwise the entry's resolved canonical permalink
• imageUrl: frontmatter.ogImage / frontmatter.image, otherwise site.defaultOgImage
• noindex: frontmatter.noindex === true
• publishedTime: published / date / created
• modifiedTime: updated, falling back to the publish time
• tags, readingTimeMinutes
• JSON-LD: BlogPosting and BreadcrumbList

Pass the page's headTags when they already include a BreadcrumbList (for example contributed by the breadcrumbs plugin) and this plugin omits its own list, so the page keeps a single BreadcrumbList entity.

Websites (buildWebsiteSeo)

Title, description, canonical URL, default image, and JSON-LD WebSite + BreadcrumbList for index, tag, and other non-article pages. The BreadcrumbList is omitted under the same headTags condition as articles.

Feeds, sitemap, and robots

Feed and sitemap entries are filtered with isPublished, exclude noindex: true, and are sorted by the most recent update first. Their URLs use each entry's resolved canonical permalink (ContentManifestEntry.permalink); they are never rebuilt from slugs. Feeds include the latest 30 entries by default. Set feed.limit to change the shared limit for RSS, Atom, and JSON Feed.

Reading time

calculateReadingTime counts CJK characters (500/min) and Latin words (220/min), rounding up to at least 1 minute.

Frontmatter fields

Exports

• seo(options?) — plugin factory
• Types: SeoPluginOptions, FeedOptions, SeoMetadata, WebsiteSeoInput, RenderableFeedEntry
• Helpers: buildArticleSeo, buildWebsiteSeo, buildAbsoluteUrl, buildPostUrl, getDescription, filterFeedEntries, getEntryPublishedTime, getEntryUpdatedTime, getHtmlLanguage, calculateReadingTime, renderSitemap, renderRobots, renderRssFeed, renderAtomFeed, renderJsonFeed

See also

• Plugin guide