View Source SEO (SEO v0.1.0)

WORK IN PROGRESS, DO NOT USE

/ˈ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.

installation

Installation

def deps do
  [
    {:seo, "~> 0.1.0"}
  ]
end

usage

Usage

  1. Define an SEO module for your web application and defaults
defmodule MyAppWeb.SEO do
  use SEO, [
    json_library: Jason,
    site: SEO.Site.build(
      default_title: "Default Title",
      description: "A blog about development",
      title_suffix: " · My App"
    ),
    open_graph: SEO.OpenGraph.build(
      description: "A blog about development",
      site_name: "My Blog",
      type: :website,
      locale: "en_US"
    ),
    twitter: SEO.Twitter.build(
      site: "@example",
      site_id: "27704724",
      creator: "@example",
      creator_id: "27704724",
      card: :summary
    )
  ]
end
  1. Implement functions to build SEO information about your entities
defmodule MyApp.Article do
  # This might be an Ecto schema or a plain struct
  defstruct [
      :id,
      :title,
      :short_description,
      :reading_time,
      :category,
      :author,
      :published_at,
      tags: []
    ]
end

defimpl SEO.OpenGraph.Build, for: MyApp.Article do
  alias MyAppWeb.Router.Helpers, as: Routes
  @endpoint MyAppWeb.Endpoint

  def build(article, default \\ nil) do
    SEO.OpenGraph.build([
      title: article.title,
      type_detail: SEO.OpenGraph.Article.build(
        published_time: article.published_at,
        author: article.author.name,
        section: "Reviews",
        tag: article.tags
      ),
      image: put_image(article),
      url: Routes.article_url(@endpoint, article.id),
      type: :article,
      description: article.short_description
    ], default)
  end
end

defimpl SEO.Site.Build, for: MyApp.Article do
  def build(article, default \\ nil) do
    [
      title: article.title,
      description: article.short_description
    ]
  end

  def unfurl(article) do
    [
      label1: "Reading Time",
      data1: "#{article.reading_time} min",
      label2: "Category",
      data2: article.category
    ]
  end

  def twitter(article) do
    if creator = article.author.twitter_handle do
      []
    else
      [creator: creator]
    end
  end

  def breadcrumb_list(article) do
    [
      [name: "Articles", item: Routes.article_url(@endpoint, :index)],
      [name: article.title, item: Routes.article_url(@endpoint, :show, article.id)]
    ]
  end

  defp put_image(article) do
    file = "/images/article/#{article.id}.png"

    exists? =
      [Application.app_dir(:my_app), "/priv/static", file]
      |> Path.join()
      |> File.exists?()

    if exists? do
      Routes.static_url(@endpoint, file), image_alt: article.title}
    else
      nil
    end
  end
end
  1. Assign the item to your conns and/or sockets
# In a plain Phoenix Controller
def show(conn, params) do
  article = load_article(params)

  conn
  |> SEO.assign(article)
  |> render("show.html")
end

def index(conn, params) do
  conn
  |> SEO.assign(%{title: "Listing Best Hugs"})
  |> render("show.html")
end

# In a Phoenix LiveView, make sure you handle with
# mount/3 or handle_params/3 so it's present on
# first static render.
def mount(_params, _session, socket) do
  {:ok, socket, temporary_assigns: [SEO.key()]}
end

def handle_params(params, _uri, socket) do
  {:noreply, SEO.assign(socket, load_article(params))}
end
  1. Juice up your root layout
<head>
  <%# remove the Phoenix-generated <.live_title> component %>
  <%# and replace with SEO.juice component %>
  <SEO.juice config={MyAppWeb.SEO.config()} item={SEO.item(assigns)} page_title={assigns[:page_title]} />
</head>

Alternatively, you may selectively render components. You can provide runtime configuration this way as well. For example:

<head>
  <%# With your SEO module's configuration %>
  <SEO.OpenGraph.meta item={SEO.Build.open_graph(SEO.item(assigns), MyAppWeb.SEO.config(:open_graph))} />

  <%# Or with runtime configuration %>
  <SEO.OpenGraph.meta item={SEO.Build.open_graph(SEO.item(assigns), %{site_name: "Foo Fighters"})} />

  <%# Or without configuration is fine too %>
  <SEO.OpenGraph.meta item={SEO.Build.open_graph(SEO.item(assigns))} />
</head>

Link to this section Summary

Functions

Assign the SEO item from the Plug.Conn or LiveView Socket

Fetch the SEO item from the Plug.Conn or LiveView Socket

Provide SEO juice. Requires an item and passes the item through all available domains

Link to this section Functions

Link to this function

assign(conn_or_socket, item)

View Source

Assign the SEO item from the Plug.Conn or LiveView Socket

@spec item(Plug.Conn.t() | Phoenix.LiveView.Socket.t()) :: any()

Fetch the SEO item from the Plug.Conn or LiveView Socket

Provide SEO juice. Requires an item and passes the item through all available domains

<head>
  <%# remove the Phoenix-generated <.live_title> component %>
  <%# and replace with SEO.juice component %>
  <SEO.juice config={MyAppWeb.SEO.config()} item={SEO.item(assigns)} page_title={assigns[:page_title]} />
</head>

Alternatively, you may selectively render components:

<head>
  <%# With your SEO module's configuration %>
  <SEO.OpenGraph.meta item={SEO.OpenGraph.Build.build(SEO.item(assigns), MyAppWeb.SEO.config(:open_graph))} />

  <%# Or with runtime configuration %>
  <SEO.Twitter.meta item={SEO.Twitter.Build.build(SEO.item(assigns), %{site_name: "Foo Fighters"})} />

  <%# Or without configuration is fine too %>
  <SEO.Unfurl.meta item={SEO.Unfurl.Build.build(SEO.item(assigns))} />
</head>

attributes

Attributes

  • item (:any) (required) - Item to render that implements SEO.Build.
  • page_title (:string) - Page Title. Overrides item's title if supplied. Defaults to nil.
  • config (:any) - Configuration for your SEO module. Defaults to nil.