1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-04 10:34:51 +02:00
video.js/docs/index.md

36 lines
2.0 KiB
Markdown
Raw Normal View History

2012-11-15 02:52:32 +03:00
[Video.js homepage](http://videojs.com)
2012-11-15 02:51:05 +03:00
<h1>Video.js Documentation</h1>
2012-01-06 10:25:09 +03:00
There are two categories of docs: [Guides](./guides/) and [API docs](./api/). Guides explain general topics and use cases (e.g. setup). API docs are automatically generated from the codebase and give specific details about functions, properties, and events.
2012-01-06 10:25:09 +03:00
(Corrections and additions welcome)
2012-11-15 02:51:05 +03:00
## Guides
2012-11-15 02:51:05 +03:00
### Getting Started
2012-11-15 02:51:05 +03:00
2014-10-17 21:55:53 +03:00
* [Setup](./guides/setup.md) - The setup documentation gives a deeper view of the additional methods you can use to trigger the player setup.
2012-01-06 10:25:09 +03:00
* [Options](./guides/options.md) - There are a number of options that can be used to change how the player behaves, starting with the HTML5 media options like autoplay and preload, and expanding to Video.JS specific options.
2012-01-06 10:25:09 +03:00
* [Tracks](./guides/tracks.md) - Text Tracks are used to display subtitles and captions, and add a menu for navigating between chapters in a video.
2012-01-06 10:25:09 +03:00
### Customizing
2012-01-06 10:25:09 +03:00
* [API](./guides/api.md) - The Video.js API allows you to control the video through javascript or trigger event listeners, whether the video is playing through HTML5, flash, or another playback technology.
2012-01-06 10:25:09 +03:00
* [Skins](./guides/skins.md) - You can change the look of the player across playback technologies just by editing a CSS file. The skins documentation gives you a intro to how the HTML and CSS of the default skin is put together.
* [Tech](./guides/tech.md) - A 'playback technology' is the term we're using to represent HTML5 video, Flash, and other video plugins, as well as other players like the YouTube player. Basically anything that has a unique API to audio or video. Additional playback technologies can be added relatively easily.
2012-03-23 02:50:17 +03:00
* [Plugins](./guides/plugins.md) - You can package up interesting Video.js customizations and reuse them elsewhere. Find out how to build your own plugin or use one created by someone else.
### Resources
* [Glossary](./guides/glossary.md) - Some helpful definitions.
## API Docs
2013-11-08 17:42:36 +03:00
- The most relevant API doc is the [player API doc](./api/vjs.Player.md).
- [Full list of API Docs](./api/)