@docus/social-image

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

2. Add @docus/social-image to the buildModules section of your nuxt.config.js

{
  buildModules: [
    '@docus/social-image'
  ]
}

Usage

Add a social-image-preview page to your app, and generate an image for each of your Docus page with that page.

You can take a look at the shipped social-image-preview.vue.

Development

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