astro-seo-meta

Astro seo provides a <Seo> component to update meta tags

latest

Source

npm

Version: 5.2.0

Version published: 2 months ago

Weekly downloads: 715

Maintainers: 2

Weekly downloads

Created: 3 years ago

Source

🚀 Astro SEO Meta

This Astro component makes it easy to add tags that are relevant for search engine optimization (SEO) to your pages.

It supports Facebook, Twitter, Open Graph, and meta tags.

📦 Installation

Install using pnpm:

pnpm add astro-seo-meta

Or using npm:

npm install astro-seo-meta

Or using yarn:

yarn add astro-seo-meta

🥑 Usage

To add a base set of SEO tags in any of your Astro pages, import Astro Seo and then use the component inside the <head> section of your HTML:

---
import { Seo } from 'astro-seo-meta';
---

<html lang="en">
  <head>
    <Seo
      title="My astro website"
      description="My fast astro website"
      icon="/favicon.ico"
    />
  </head>

  <body>
    <h1>Hello from astro</h1>
  </body>
</html>

📖 API Reference

`<Seo>`

Name	Required	Example	Description
`title`	`false`	`"My Astro website"`	Page title.
`description`	`false`	`"My blazing fast Astro website"`	Description of the page.
`keywords`	`false`	`["website", "blog", "astro"]`	Array of keywords.
`icon`	`false`	`"/favicon.ico"`	Tab icon URL.
`themeColor`	`false`	`"#000000"`	Browser theme color.
`colorScheme`	`false`	`"light"`	Preferred color scheme.
`robots`	`false`	`"index, follow"`	string of robots directives (e.g., `index`, `noindex`, `follow`).
`facebook.image`	`false`	`"/facebook.png"`	Facebook share image.
`facebook.url`	`false`	`"https://astro.build"`	Page URL.
`facebook.type`	`false`	`"website"`	Type of resource. See all types.
`twitter.image`	`false`	`"/twitter.png"`	Twitter share image.
`twitter.site`	`false`	`"@astrodotbuild"`	Twitter handle of the publishing site.
`twitter.card`	`false`	`"summary"`	Format of Twitter share card. See all types.

All of the Seo props are optional. If a prop is not provided, the associated meta tag will not be rendered.

// renders no seo tags
<Seo />

// renders all seo tags
<Seo
  title="My Astro website"
  description="My blazing fast astro website"
  keywords={['website', 'blog', 'astro']}
  icon="/favicon.ico"
  themeColor="#000000"
  colorScheme="light"
  robots="index, follow"
  facebook={{
    image: '/facebook.png',
    url: 'https://astro.build',
    type: 'website'
  }}
  twitter={{
    image: '/twitter.png',
    site: '@astrodotbuild',
    card: 'summary'
  }}
/>

// renders some seo tags
<Seo
  title="My Astro website"
  description="My blazing fast astro website"
  keywords={['website', 'blog', 'technology']}
/>