This Astro component makes it easy to add tags that are relevant for seach engine optimization (SEO) to your pages.
The ultimate goal is to make this the one-stop shop for most of your SEO needs when developing Astro sites.
Pull requests and/or feature requests are very welcome!
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'
---
<html lang="en">
<head>
<SEO
title="A Very Descriptive Title"
description="A heavily optimized description full of well-researched keywords."
/>
</head>
// ... rest of <head>
<body>
// ... body
</body>
</html>
| Propname | Type | Description |
|---|---|---|
| title | string | The title of the page. |
| description | string | Text that gives a concise description of what your page is about. |
| canoncial | string | Prevent duplicate content issues by specifying the "canonical" or "preferred" url of a web page. |
| noindex | boolean | Set this to true if you don't want search engines to index your page. Since this is an SEO component, this gets set to false by default. This way, indexing is strictly opt-out. |
| nofollow | boolean | Set this to true if you don't want search engines to follow links |
on your page. Since this is an SEO component, this gets set to false by default. This way, following links is strictly opt-out. | ||
| openGraph.title | string | Set the title Open Graph should use. This can differ from your general page title. If you define this, you mus define the other 3 OG basic properties as well: type, image and url. (Learn more.) |
| openGraph.type | string | Set the type Open Graph should use. If you define this, you mus define the other 3 OG basic properties as well: title, image and url. (Learn more.) |
| openGraph.image | string | URL of the image that should be used in social media previews. If you define this, you mus define the other 3 OG basic properties as well: title, type and url. (Learn more.) |
| openGraph.url | string | The canonical URL of your object that will be used as its permanent ID in the graph. Mostl likely either the url of the page or its canonical url (see above). If you define this, you mus define the other 3 OG basic properties as well: title, type and image. (Learn more.) |
Our first goal for this project is to support the most-used tags that are relevant for SEO. That includes the most-used open graph tags.
After that comes feature-parity with Next SEO. After that ... we'll see.
There's certainly no magic to what Astro SEO does. Basically, it bundles the
creation of regular SEO-relevant HTML tags inside one component that you can
then use inside your page's <head> tag.
The translation between props and tags is pretty direct and almost 1:1. After
building, there probably won't be anything you wouldn't have written yourself.
The idea is to surface the options that exist in a central place and adhere to
best practices where it's theoretically possible not to. If you want to see
how the sausage gets made, there's only one place you will have to check:
/src/SEO.astro
If you want, you can view Astro SEO as a checklist, so you don't forget a tag. Or maybe also as an educational tool, to see which options exist in the first place.
Astro SEO is heavily inspired by Next SEO and all the amazing work Gary is doing developing it. Thanks Gary! ❤️
FAQs
Makes it easy to add SEO relevant tags to your Astro app.
The npm package astro-seo receives a total of 3,220 weekly downloads. As such, astro-seo popularity was classified as popular.
We found that astro-seo demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.