Noteworthy Programming Masterpiece
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@agentofuser/remark-giphy

1.0.1 • Public • Published

remark-giphy

Downloads Chat

Add giphy: as a CommonMark URI scheme.

Examples:

  • Replace ![](giphy:search_term) with first matching gif from giphy.
  • Replace ![](<giphy:unescaped query>) with first matching gif from giphy.
  • Replace [link](<giphy:search term>) with first matching gif from giphy.

Installation

yarn:

yarn add @agentofuser/remark-giphy

Usage

Say we have the following file, demo.md:

Hello there! 👋
 
![](giphy:whats_up 'How is it going?')

And our script, example.js, looks as follows:

var fs = require('fs')
var remark = require('remark')
var giphy = require('@agentofuser/remark-giphy')
 
remark()
  .use(giphy, { giphyApiKey: 'your-key' })
  .process(fs.readFileSync('demo.md'), function(err, file) {
    if (err) throw err
    console.log(String(file))
  })

Now, running node example yields:

Hello there! 👋
 
![](https://media.giphy.com/media/eoVusT7Pi9ODe/giphy.gif 'How is it going?')

API

remark().use(giphy, options)

Take ![](giphy:search_term) and replace with first matching gif from giphy.

  • The object options MUST contain a valid Giphy API key as the giphyApiKey property.

  • The object options MAY contain a valid Giphy API ID as the notFoundGiphyId property. It will be used when there are no search results for the term used. The default is this one:

    404 not found

Contribute

See contributing.md in remarkjs/remark for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Agent of User

Install

npm i @agentofuser/remark-giphy

DownloadsWeekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

153 kB

Total Files

19

Last publish

Collaborators

  • avatar