1.0.1 ā€¢ Published 3 years ago

gatsby-remark-link-preview v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Gatsby Remark plugin to embed Notion-like card UI about link.

This is a fork from gatsby-remark-link-card, šŸ‘€ You can preview the description of the link!

šŸšš Install

$ npm install --save gatsby-remark-link-preview
# or
$ yarn add gatsby-remark-link-preview

šŸš€ How to use

šŸ‘‰ This plugin requires gatsby-transformer-remark.

in Markdown

[$card](https://github.com/lichin-lin/gatsby-remark-link-preview/)

with Config

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-transformer-remark`,
    options: {
      plugins: [
        {
          resolve: `gatsby-remark-link-preview`,
          options: {
            //...
          }
        }
      ]
    }
  }
];

āš™ Options

PropertyTypeDefaultDescription
delimiterstring$cardTitle of the link to create a card
imagestringdata-uriDefault og image path
faviconstringdata-uriDefault favicon image path
timeoutnumber30000Default timeout(ms) for puppeteer
errorObject-Default config when error

Author

šŸ‘¤ Lichin Lin

Inspiration

gatsby-remark-link-card

Show your support

Give a ā­ļø if this project helped you!