remark-oembed

June 5, 2019 ยท View on GitHub

Downloads Chat

Converts URLs surrounded by newlines into embeds.

The important part of this code is taken directly from Benedicte Raae's excellent gatsby-remark-oembed plugin, so thank you very much @raae ๐Ÿ™

Installation

yarn:

yarn add @agentofuser/remark-oembed

Usage

Say we have the following file, demo.md:

Hey this is a nice youtube video about making modern react apps with gatsby:

https://www.youtube.com/watch?v=GN0xHSk2P8Q

Check it out ๐Ÿ‘†

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

var fs = require('fs')
var remark = require('remark')
var oembed = require('@agentofuser/remark-oembed')

remark()
  .use(oembed)
  .process(fs.readFileSync('demo.md'), function(err, file) {
    if (err) throw err
    console.log(String(file))
  })

Now, running node example yields:

Hey this is a nice youtube video about making modern react apps with gatsby:

<iframe 
  width="480" 
  height="270" 
  src="https://www.youtube.com/embed/GN0xHSk2P8Q?feature=oembed" 
  frameborder="0" 
  allow="accelerometer; 
    autoplay; 
    encrypted-media; 
    gyroscope; 
    picture-in-picture" 
  allowfullscreen>
</iframe>

Check it out ๐Ÿ‘†

API

remark().use(oembed)

Converts URLs surrounded by newlines into embeds.

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