API Reference SEO v0.1.0

modules

Modules

SEO

WORK IN PROGRESS, DO NOT USE

This is SEO for Google to display breadcrumbs in the search results. This allows the search result to search as multiple links.

The referenced item in a SEO.Breadcrumb.ListItem

A SEO.Breadcrumb.List is list of items consisting of a chain of linked Web pages, typically described using at least their URL and their name, and typically ending with the current page.

Facebook originally developed the OpenGraph standard, so much of social-sharing techniques are contained in SEO.OpenGraph, however there remains one Facebook-specific attribute: the :app_id.

Build OpenGraph tags. This is consumed by platforms such as Google, Facebook, Twitter, Slack, and others.

Metadata describing an article.

Data describing an audio file.

Metadata describing a book

URL or details for the image. The og:image property has some optional structured properties

  • :first_name - A name normally given to an individual by a parent or self-chosen.
  • :last_name - A name inherited from a family or marriage and by which the individual is commonly known.
  • :username - A short unique string to identify them.
  • :gender - Their gender.

resources

Resources

Data describing a video.

Metadata about your site.

With Twitter Cards, you can attach rich photos, videos and media experiences to Tweets, helping to drive traffic to your website. Users who Tweet links to your content will have a "Card" added to the Tweet that's visible to their followers.

Some platforms (eg, Slack and Discord) have adopted an older and deprecated Twitter Product Card specification that allows for two arbitrary data points. For example, some blogs may include a reading time. Another example, if selling a product you may display a variation (eg, color is black) and also display the price (eg, price is $20).