@docus/social-image-edge

Generate Social Preview Image for Docus pages.

Usage no npm install needed!

<script type="module">
  import docusSocialImageEdge from 'https://cdn.skypack.dev/@docus/social-image-edge';
</script>

README

Docus Social Image Module

Generate Social Preview Image for Docus pages.

Quick Setup

  1. Add @docus/social-image dependency to your project:
# using yarn
yarn add --dev @docus/social-image
# using npm
npm install --save-dev @docus/social-image
  1. Add @docus/social-image to the buildModules section of your nuxt.config.js
{
  buildModules: [
    '@docus/social-image'
  ]
}

Development

  1. Clone this repository
  2. Install dependencies using yarn install
  3. Start dev server using yarn dev