nodebb-plugin-ns-embed/README.md

Embed media and rich content in posts: youtube, vimeo, twitch etc. All embeds are based on the rules. You are encouraged to build your own rules to embed everything what is embeddable.

# NodeBB Embed

Embed media and rich content in posts: youtube, vimeo, twitch etc. All embeds are based on the rules. You are encouraged to build your own rules to embed everything what is embeddable.

![Version](https://img.shields.io/npm/v/nodebb-plugin-ns-embed.svg)
![Dependencies](https://img.shields.io/librariesio/github/NicolasSiver/nodebb-plugin-ns-embed)
![GitHub Actions](https://github.com/NicolasSiver/nodebb-plugin-ns-embed/actions/workflows/nodejs.yml/badge.svg)

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 

- [Embeds Supported by Default](#embeds-supported-by-default)
- [Screenshots](#screenshots)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

The plugin works well with default `Markdown` plugin or without it, i.e. there is no alteration of links in user's posts.

## Embeds Supported by Default

Most embeds are responsive with a limited width to `640px`

- Coub
- Twitch (video and channel)
- Vimeo
- Vine
- Youtube (short and normal URL)

If you would like to have more embeddable services, please refer to the [Community Embed Rules](docs/community-rules.md).

## Screenshots

![Admin Panel View](screenshot.png)