nuxt-dynamic-images v0.0.1

nuxt-dynamic-images

Features

• Generate social media images from @nuxt/content documents
• Design and build in any css framework you want

NOTE This only works with nuxt generate with ssr: true

Quick Setup

1. Add nuxt-dynamic-images dependency to your nuxt project that already uses @nuxt/content.

# using yarn
yarn add nuxt-dynamic-images

# using npm
npm install nuxt-dynamic-images

2. Add nuxt-dynamic-images to the buildModules section of nuxt.config.js

{
  buildModules: [
    // Simple usage
    'nuxt-dynamic-images',

    // With options
    ['nuxt-dynamic-images', { /* module options */ }]
  ]
}

Or a separate section dynamicImages for module options:

{
  buildModules: [
    // Simple usage
    'nuxt-dynamic-images',
  ],
  dynamicImages: {
    /* module options */
  }
}

Options

nuxt-dynamic-images has the following configuration options:

• fields: Array<string> A list of all the fields nuxt-dynamic-images will generate from in the @nuxt/content folder. By default this is ['twitterImage', 'facebookImage'].

• elSelector: string The DOM selector puppeteer will screenshot. By default this is #image.

• publicPath: string The public path inside the nuxt public path where images will be saved. By default this is /images so generated images (by default) will have a url like /_nuxt/images/post-twitterImage.png.

• puppeteerOptions?: any Raw options to give to puppeteer.launch(). By default this is an empty object.

Usage

For a complete usage example, see the example/ directory. But here is a short run down with the default configuration:

1) Create some @nuxt/content files with image fields:

---

title: Example Blog Post!

facebookImage: /_public/social
twitterImage: /_public/social

---

Here is an example `@nuxt/content` document with a generated social media
images!

2) Create a page at /_public/social:

<template>
  <div :class="${field}" id="image">
    <h1>{{ post.title }}</h1>
    <h2>{{ post.createdAt }}</h2>
  </div>
</template>

<script>
export default {
  async asyncData ({ $content, ssrContext }) {
    const { contentPath, contentField } = ssrContext
    const post = await $content(contentPath).fetch()

    return { post, field: contentField }
  }
}
</script>

<style scoped>
  .facebookImage {
    height: 628px;
    width: 1200px;
  }

  .twitterImage {
    height: 335px;
    width: 600px;
  }
</style>

TODO

Follow the GitHub issues for a more up to date status, but here is a general list of next steps:

• Setup caching
• Get some working setup when using nuxt dev
• A better DX setup so you can view the images while designing them (no longer use ssrContext)
• Documentation site
• Try to figure out a more sane default configuration
• Tests

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start hacking away!

License

MIT License

Copyright (c)

Maintained by Blake Kostner