# remarkable-youtube

> Renders YouTube video links with iframe.

Latest version **1.2.2** (published 2020-06-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install remarkable-youtube
pnpm add remarkable-youtube
yarn add remarkable-youtube
bun add remarkable-youtube
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2020-06-08 |
| First published | 2018-03-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Vitaliy Bobrov |
| Maintainers | bobrov1989 |
| Keywords | remarkable, plugin, video, youtube, iframe |

## Links

- npm: https://www.npmjs.com/package/remarkable-youtube
- Repository: https://github.com/vitaliy-bobrov/remarkable-youtube
- Homepage: https://github.com/vitaliy-bobrov/remarkable-youtube#readme
- Issues: https://github.com/vitaliy-bobrov/remarkable-youtube/issues
- npm.io page: https://npm.io/package/remarkable-youtube

## Dependencies (1)

- [remarkable](https://npm.io/package/remarkable.md) ^2.0.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2020-06-08
- 1.2.1 — 2018-05-23
- 1.2.0 — 2018-05-23
- 1.1.2 — 2018-05-20
- 1.1.1 — 2018-05-20
- 1.1.0 — 2018-05-20
- 1.0.2 — 2018-03-19
- 1.0.1 — 2018-03-19
- 1.0.0 — 2018-03-19

## README

# remarkable-youtube
[![npm version](https://badge.fury.io/js/remarkable-youtube.svg)](https://badge.fury.io/js/remarkable-youtube)
[![npm](https://img.shields.io/npm/dt/remarkable-youtube.svg)](https://github.com/vitaliy-bobrov/remarkable-youtube)

[Remarkable](https://github.com/jonschlinkert/remarkable) plugin renders YouTube links as iframe.

## Installation
- npm:
  `npm install --save-dev remarkable-youtube`

- yarn:
  `yarn add -D remarkable-youtube`

## Usage
```js
const Remarkable = require('remarkable');
const youtube = require('remarkable-youtube');
const md = new Remarkable();

md
  .use(youtube, {
    className: 'youtube-iframe'
  });
```

In markdown files write link like:

```
[Video](youtube:YOUR_VIDEO_ID)
```

## Options

### className {String}

Additional class name to add on iframe element.

### origin {String}

Specify web-site origin parameter.

### related {Boolean}

Specify if YouTube player should show related videos at the end of a playback.

### attr {String}

Specify the attribute name to use for source. Default value `src`. Could be used to make videos lazy loaded, for example.

---
_Source: https://npm.io/package/remarkable-youtube · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
