API Reference SEO v0.1.10
modules
Modules
/ˈin(t)ərˌnet jo͞os/
noun: internet juice
SEO (Search Engine Optimization) provides a framework for Phoenix applications to more-easily optimize your site for search engines and displaying rich results when your URLs are shared across the internet. The better visibility your pages have in search results, the more likely you are to have visitors.
This is SEO for Google to display breadcrumbs in the search results. This allows the search result to search as multiple links.
Implement build/2
which receives your item and conn and returns a SEO.Breadcrumb.List.t
or nil
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.
One item in a SEO.Breadcrumb.List
Configuration for SEO. This is implemented for you when you use SEO
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
.
Implement build/2
which receives your item and conn and returns a SEO.Facebook.t
or nil
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
Implement build/2
which receives your item and conn and returns a SEO.OpenGraph.t
or nil
URL or details for the image. The og:image
property has some optional structured properties
Data describing a video.
Metadata about your site.
Implement build/2
which receives your item and conn and returns a SEO.Site.t
or nil
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.
Implement build/2
which receives your item and conn and returns a SEO.Twitter.t
or nil
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).
Implement build/2
which receives your item and conn and returns a SEO.Unfurl.t
or nil