SEO support

When creating a site I want to set description, image, title set on page (and have default values) so that have good SEO

There are really two parts to this:

• Site-wide SEO: common and/or default SEO values for the whole site (and especially the front page)
• Per-page SEO: SEO per page that overrides default SEO values. These would derive from frontmatter and/or be calculated e.g. title from markdown first heading etc (nb: any work to calculate title etc is out of scope for this issue - this issue can assume those values are available)

Priority right now is the first

We can follow the work we did in web3 for this e.g. https://github.com/life-itself/web3/issues/114

Acceptance

• Can configure default SEO - full stack of next-seo options in config and these get used on every page (can get overriden) ✅2022-08-16 see https://flowershow.app/docs/seo and https://socialsharepreview.com/?url=https://flowershow.app
  • This SEO shows up on front page ✅2022-08-16 see https://socialsharepreview.com/?url=https://flowershow.app
  • SEO shows up on every other page where not explicitly overridden ✅2022-08-16 this works
  • Docs page explaining how to set and referencing options in next-seo ✅2022-08-16 https://flowershow.app/docs/seo
• Per page SEO values for title, description, image etc which come from frontmatter or elsewhere 🚧2022-08-16 done for title, description but not image yet. An example can be see on https://flowershow.app/docs/seo where title is different

Proposed Default Next SEO (note other SEO values would get set from other config values e.g. title and description)

nextSeo: {
    openGraph: {
      images: [
        {
          url: "https://web3.lifeitself.us/img/home-page-screenshot-social-preview.png",
          alt: "",
          width: 1200,
          height: 627,
          type: "image/jpg",
        },
      ],
    },
    twitter: {
      handle: "@forlifeitself",
      site: "web3.lifeitself.us",
      cardType: "summary_large_image",
    },
  },

Tasks

• Create docs
• …

[olayway]

@olayway @khalilcodes i would keep these as we could use these outside of SEO, at least the title would be used in the navbar by default i think if you hadn’t set a logo or something. Description maybe not so much. That said, for now i think we could go this way - i actually think @olayway is right that we move this to the SEO and have a separate value (if we need it) for say the navbar.

Yup, I’d keep SEO-related stuff from other (e.g. presentation-related) stuff separate.

[rufuspollock]

I don’t think it makes much sense to have title and description properties outside of nextSeo property. They are used for SEO only and are also listed as options of NextSeo package, so I’d keep them where other SEO config options are. Also, currently we’re not allowing users to just use title they set. Instead, titleTemplate of the following form is forced: '%s | ’ + siteConfig.title

@olayway @khalilcodes i would keep these as we could use these outside of SEO, at least the title would be used in the navbar by default i think if you hadn’t set a logo or something. Description maybe not so much. That said, for now i think we could go this way - i actually think @olayway is right that we move this to the SEO and have a separate value (if we need it) for say the navbar.

And btw @olayway very good, thorough comments.