Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue #8179 from video.js repo - Updated getting-started.mdx #193

Closed
wants to merge 13 commits into from
16 changes: 15 additions & 1 deletion src/mdx-pages/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,21 @@ Video.js/
└── video.min.js
```

This package includes everything you'll need to use Video.js on a production site. By default, we bundle Video.js with Mozilla's excellent [VTT.js](https://github.com/mozilla/vtt.js). If you don't need VTT.js functionality for whatever reason, you can use one of the Video.js copies that don't include VTT.js. These have <code>novtt</code> in the name and can be found in the <code>alt/</code> directory. <code>font/</code> includes all the generated icon font files from the [Videojs Font project](https://github.com/videojs/font). <code>lang/</code> contains all the generated translation files.
This package includes everything you'll need to use Video.js on a production site.

#### Explanation of the Versions

- **video.js**: The default build of Video.js, which includes the [HTTP Streaming (VHS)](https://github.com/videojs/http-streaming) playback engine for HLS and DASH playback with [Media Source Extensions](https://developer.mozilla.org/en-US/docs/Web/API/Media_Source_Extensions_API) and [our fork of Mozilla's VTT.js](https://github.com/videojs/vtt.js/).
- **alt/video.core.js**: The core version of Video.js without VHS.
- **alt/video.core.novtt.js**: The core version of Video.js without VTT.js, suitable if you don't need VTT.js functionality.
- **alt/video.novtt.js**: A version of Video.js with VHS but without VTT.js.

ravixalgorithm marked this conversation as resolved.
Show resolved Hide resolved
Each file is also available as a `.min.js` version for production which is minified with uglify-js.

The sizes for each can be viewed at https://www.npmjs.com/package/video.js?activeTab=code


<code>font/</code> includes all the generated icon font files from the [Videojs Font project](https://github.com/videojs/font). <code>lang/</code> contains all the generated translation files.

### Source Code

Expand Down