npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

remark-webembed

v0.0.1

Published

remark plugin to embed web content using markdown directives

Downloads

14

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

timlrxtimlrx

Keywords

remarkremark-pluginwebembedmdxmarkdown

Readme

Remark Webembed

remark plugin to embed web content using markdown directives.

Out of the box support for oembed and custom providers. Automatically wraps the iframe into a responsive container.

Can be used on the server or in the browser (though certain oembed API providers block cross-origin requests).

Installation

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm install remark-webembed

Usage

import { unified } from 'unified'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import remarkDirective from 'remark-directive'
import rehypeStringify from 'rehype-stringify'
import remarkWebembed from 'remark-Webembed'

unified()
  .use(remarkParse)
  .use(remarkDirective)
  .use(remarkWebembed, options)
  .use(remarkRehype)
  .use(rehypeStringify)
  .process(markdown)

Sample web embed

Input:

::embed[https://www.youtube.com/watch?v=32I0Qso4sDg]

HTML Output:

<div>
  <head></head>
  <body>
    <div
      class="webembed-wrapper"
      style="position: relative; overflow: hidden; width: 100%; padding-top: 56.49999999999999%;"
    >
      <iframe
        width="100%"
        height="100%"
        src="https://www.youtube.com/embed/32I0Qso4sDg?feature=oembed"
        frameborder="0"
        allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
        allowfullscreen
        title="[HOONIGAN] Gymkhana 2020: Travis Pastrana Takeover; Ultimate Hometown Shred in an 862hp Subaru STI"
        style="position: absolute; top: 0; left: 0; border: 0;"
        class="webembed-iframe"
      ></iframe>
    </div>
  </body>
</div>

API

remark().use(remarkWebembed, [options])

options

options.queryParams

Type: object.

Query parameters passed to the oembed API. If maxWidth or maxHeight is specified, it will be applied to the iframe container as well.

Check the oembed provider's documentation for supported query parameters.