Skip to content

Latest commit

 

History

History
105 lines (76 loc) · 3.25 KB

README.md

File metadata and controls

105 lines (76 loc) · 3.25 KB
Raw

🚀 Astro JSON-LD Schema

version downloads github actions typescript makepr

Easily insert valid Schema.org JSON-LD in your Astro apps.

The <Schema> component is inspired by react-schemaorg and powered by the schema-dts package for full TypeScript definitions.

This <Schema> component:

  1. Adds type checking to validate user-provided schema JSON
  2. Escapes the JSON data.
  3. Outputs a <script type="type="application/ld+json"> with the escaped schema.

📦 Installation

First, install the schema-dts & astro-seo-schema packages using your package manager. (If you aren’t sure which package manager you’re using, run the first command.)

Using PNPM

pnpm install schema-dts astro-seo-schema

Using NPM

npm install schema-dts astro-seo-schema

Using Yarn

yarn add schema-dts astro-seo-schema

🥑 Usage

To insert a simple JSON-LD snippet in any of your Astro pages, import Schema component and then use the component inside the <head> section of your HTML:

---
import { Schema } from "astro-seo-schema"
---

<html lang="en">
    <head>
        <Schema
            item={{
                "@context": "https://schema.org",
                "@type": "Person",
                name: "Grace Brewster",
                alternateName: "Grace Brewster Murray Hopper",
                alumniOf: {
                    "@type": "CollegeOrUniversity",
                    name: ["Yale University", "Vassar College"],
                },
                knowsAbout: ["Compilers", "Computer Science"],
            }}
        />
    </head>

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

Looking for a simpler approach ?

If you are not into schema.org and want a simpler approach, you might want to check another alternative astro-seo-meta.

astro-seo-meta helps you to add tags that are relevant for search engine optimization (SEO) to your astro pages.

Changelog

Please see the Changelog for more information on what has changed recently.

Acknowledgements