nuxt-structured-data

📖 Release Notes

Setup

1. Add nuxt-structured-data dependency to your project

yarn add nuxt-structured-data # or npm install nuxt-structured-data

2. Add nuxt-structured-data to the modules section of nuxt.config.js

{
  modules: [
    'nuxt-structured-data',
  ]
}

Usage

In every page, this module will inject a json-ld script based on structuredData property value.

Example

pages/schools/_slug.vue

export default {
  async asyncData({ app, error, params }) {
    try {
      const response = await app.$axios.get(`SCHOOL_API_ROUTE/${params.slug}`)

      return {
        structuredData: {
          "@type": "School",
          address: {
            "@type": "PostalAddress",
            addressLocality: response.data.city,
            addressCountry: "FR",
            streetAddress: response.data.street,
            postalCode: response.data.zip_code
          },
          email: response.data.email,
          telephone: response.data.tel,
          logo: response.data.logo
        }
      };
    } catch (err) {
      error({
        statusCode: 404,
        message: "Cannot find this school"
      })
    }
  }
}

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev

License

MIT License

Copyright (c) Quentin Neyraud [email protected]