1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
|
# markdown-it-html5-embed
This is a plugin for markdown-it which adds support for embedding audio/video in the HTML5 way, by using `<video>`/`<audio>` tags.
## Install
node.js, bower:
```bash
npm install markdown-it-html5-embed --save
bower install markdown-it-html5-embed --save
```
## Use
### With Node
```js
var md = require('markdown-it')()
.use(require('markdown-it-html5-embed'), {
html5embed: {
useImageSyntax: true, // Enables video/audio embed with ![]() syntax (default)
useLinkSyntax: true // Enables video/audio embed with []() syntax
}});
md.render('![](http://example.com/file.webm)'); // => '<p><video width="320" height="240" class="audioplayer" controls>
// <source type="video/webm" src=https://example.com/file.webm></source>
// Fallback text (see below)
// </video></p>'
```
### With Bower
```js
var md = window.markdownit({});
var html5medialPlugin = window.markdownitHTML5Embed;
md.use(html5medialPlugin, { html5embed: { useLinkSyntax: true } });
md.render(text);
```
## Features
### Embed in-place with "link syntax"
Options:
```js
useLinkSyntax: true
```
In this mode every link to media files will be replaced with HTML5 embed:
Markdown:
```markdown
[test link](https://example.com/file.webm)
```
Rendered:
```html
<p><video controls preload="metadata">
<source type="video/webm" src="https://example.com/file.webm"></source>
Your browser does not support playing HTML5 video. You can
<a href="https://example.com/file.webm" download>download a copy of the video
file</a> instead.
Here is a description of the content: test link
</video></p>
```
### Embed in-place with the "image syntax"
Options:
```js
useImageSyntax: true
```
In this mode every media file referenced with MD image syntax will be replaced with HTML5 embed:
Markdown:
```markdown
![](https://example.com/file.webm)
```
Rendered:
```html
<p><video width="320" height="240" class="audioplayer" controls>
<source type="video/webm" src="https://example.com/file.webm"></source>
Your browser does not support playing HTML5 video. You can
<a href="https://example.com/file.webm" download>download a copy of the video
file</a> instead.
</video></p>
```
Can be used along with the "link syntax".
### Embed at particular place referenced by a MD directive
Options:
```js
inline: false
```
In this mode the plugin pick every link to media files in the text and embeds them at the place pointed by specific Markdown directive.
Default value for the directive is `[[html5media]]`, but it can be adjusted by `embedPlaceDirectiveRegexp` option.
This mode always uses link syntax.
Markdown:
```markdown
[test link](https://example.com/file.webm)
[[html5media]]
```
Rendered:
```html
<p><a href="https://example.com/file.webm">test link</a></p>
<video controls preload="metadata">
<source type="video/webm" src="https://example.com/file.webm"></source>
Your browser does not support playing HTML5 video. You can
<a href="https://example.com/file.webm" download>download a copy of the video
file</a> instead.
Here is a description of the content: test link
</video>
```
### Automatic append
Options:
```js
inline: false,
autoAppend: true
```
In this mode media files are embedded at the end of the rendered text without any specific directives.
This mode always uses link syntax.
Markdown:
```markdown
[test link](https://example.com/file.webm)
```
Rendered:
```html
<p><a href="https://example.com/file.webm">test link</a></p>
<video controls preload="metadata">
<source type="video/webm" src="https://example.com/file.webm"></source>
Your browser does not support playing HTML5 video. You can
<a href="https://example.com/file.webm" download>download a copy of the video
file</a> instead.
Here is a description of the content: test link
</video>
```
### Alternative render functions
Options:
```js
renderFn: function(properties, attributes) {/* ... */}
```
By default the plugin renders media with just plain html media tags. However you may want to customize media rendering appropriate for your front-end framework or approach.
You can do this by defining a custom rendering function.
For example, here is a function you can use to render a media embed with Handlebars:
```js
function handleBarsRenderFn(properties, attributes) {
return HandlebarsTemplates[this]({
media_type: properties.mediaType,
attributes: attributes,
mimetype: properties.mimeType,
source_url: properties.url,
title: properties.title,
fallback: properties.fallback,
needs_cover: properties.mediaType === "video"
});
}
```
You can access the descriptive content (e.g., "test link" above) via the
`{{title}}` variable. It will be set to "Untitled video" or "Untitled audio"
if no title was set. You can access the fallback text ("Your browser does not
support ...") via the `{{fallback}}` variable. See below for how to
customize/translate the text.
Then you can just set this function as a `renderFn` option on the plugin initialization:
```js
// ... options setting code ...
renderFn: handleBarsRenderFn.bind("templateName"),
```
More on render function arguments see at the [`renderFn`](#renderFn) option description.
## Options reference
#### attributes
Hash. HTML attributes to pass to audio/video tags. Example:
```js
attributes: {
'audio': 'width="320" controls class="audioplayer"',
'video': 'width="320" height="240" class="audioplayer" controls'
}
```
Default:
```js
attributes: {
audio: 'controls preload="metadata"',
video: 'controls preload="metadata"'
},
```
#### autoAppend
Boolean. In inline mode, whether to append media embeds automatically or not.
If true, linked media files are embedded at the end of the post.
Default: `false`.
#### embedPlaceDirectiveRegexp
Regexp. Regular expression for the directive which is used to set the place for media embeds in case of non-inline embedding.
Default: ```/^\[\[html5media\]\]/im```
#### inline
Boolean. Embed media in-place if true, or at some specified place if false.
Default: `true`.
#### isAllowedHttp
Boolean. When `true` embed media with `http://` schema in URLs. When `false` ignore and don't count as embeddable media.
Default: `false`.
#### isAllowedMimeType
Function. If specified, allows to decided basing on the MIME type, wheter to embed element or not. If not, all audio/video content is embedded. In a web browser you can use following code to embed only supported media type:
```
is_allowed_mime_type: function(mimetype) {
var v = document.createElement(mimetype[1]);
return v.canPlayType && v.canPlayType(mimetype[0]) !== '';
}
```
This way, all unsupported media will be rendered with defualt renderer (e.g., as a link, if ```use_link_syntax``` is true).
The argument is a result of regexp match, and has a structure similar to that one:
```
[ 'audio/mpeg',
'audio',
index: 0,
input: 'audio/mpeg' ]
```
Default: `undefined`, allow everything.
#### renderFn
Function. Override the built-in render function. The function accepts exactly 2 arguments.
```js
function customRenderFn(properties, attributes) { /* ... */ }
```
`properties` is an `Object` which contains properties of a detected and parsed media reference. `properties` `Object` contains following keys:
key|type|meaning
-|-
fallback|String|Fallback text for the case when the client (e.g. browser) doesn't support HTML5 `<audio>`/`<video>`
mediaType|String|`"video"` or `"audio"`
mimeType|String|Media mime type resolved by a URL ending (media file extension)
title|String|Title for the media (which could be optionally provided in the markup)
url|String|Media URL
`attributes` is the attributes passed from the plugin options, see [`attributes`](#attributes) option description.
A custom render function must return a `String` value which contains HTML for embedding at the appropriate place.
#### useImageSyntax
Boolean. Enables video/audio embed with ```![]()``` syntax.
Default: `true`.
#### useLinkSyntax
Boolean. Enables video/audio embed with ```[]()``` syntax.
Default: `false`.
#### messages
Object. Override the built-in default fallback text. You can add translations as
well, and load the translation by invoking `md.render` with a language
environment variable, like so: `md.render('some text', { language: 'code' })`
See `lib/index.js` for the default text in English.
#### translateFn
Object. Override the built-in translation function. The function has to process
an object like this as its only argument, and return a string:
````javascript
{
messageKey: 'video not supported',
messageParam: 'somevideo.webm',
language: 'en'
}
````
The keys you need to support are defined in `lib/index.js`. You can access the
default messages, or the messages you passed via `options.messages`, through
the `this` keyword within your translation function.
## Credits
Originally based on [the code](http://talk.commonmark.org/t/embedded-audio-and-video/441/16) written by [v3ss0n](https://github.com/v3ss0n).
|