remark-giphy
!Downloadsdownloads-badgedownloads !Chatchat-badgechatAdd
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 add @agentofuser/remark-giphy## Usage
Say we have the following file, `demo.md`:
<!-- prettier-ignore -->
```markdown
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 thegiphyApiKey
- 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:Contribute
Seecontributing.md
in remarkjs/remark
contribute for ways to get
started.This organisation has a Code of Conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.