1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-29 02:57:21 +02:00
video.js/docs/index.md

96 lines
3.3 KiB
Markdown
Raw Normal View History

# [Video.js][vjs-website] Documentation
2012-11-15 02:51:05 +03:00
There are two categories of docs: [Guides](/docs/guides/) and [API docs][api].
2012-01-06 10:25:09 +03:00
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-11-15 02:51:05 +03:00
## Table of Contents
* [Resolving Issues](#resolving-issues)
* [FAQ](#faq)
* [Troubleshooting](#troubleshooting)
* [Guides](#guides)
* [Getting Started](#getting-started)
* [Setup](#setup)
* [Player Workflows](#player-workflows)
* [Options](#options)
* [Tracks](#tracks)
* [Customizing](#customizing)
* [Skins](#skins)
* [Plugins](#plugins)
* [Components](#components)
* [Tech](#tech)
* [Languages](#languages)
* [Hooks](#hooks)
* [API Docs](#api-docs)
## Resolving Issues
### [FAQ](/docs/guides/faq.md)
The frequently asked questions for video.js.
### [Troubleshooting](/docs/guides/troubleshooting.md)
Troubleshooting help for video.js.
## [Guides](/docs/guides/)
2012-11-15 02:51:05 +03:00
### Getting Started
2012-11-15 02:51:05 +03:00
#### [Setup](/docs/guides/setup.md)
The setup guide covers all methods of setting up Video.js players.
#### [Player Workflows](/docs/guides/player-workflows.md)
After mastering the basics of setup move over to this guide for some more advanced player workflows.
#### [Options](/docs/guides/options.md)
2012-01-06 10:25:09 +03:00
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](/docs/guides/tracks.md)
Tracks are used for displaying text information over a video, selecting different audio tracks for a video, or selecting different video tracks.
2012-01-06 10:25:09 +03:00
### Customizing
2012-01-06 10:25:09 +03:00
#### [Skins](/docs/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. For a list of skins you can check the [video.js wiki][skins-list].
2012-01-06 10:25:09 +03:00
#### [Plugins](/docs/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][plugins-list].
2012-03-23 02:50:17 +03:00
#### [Components](/docs/guides/components.md)
Video.js is built around a collection of components. These are the building blocks of the player UI.
#### [Tech](/docs/guides/tech.md)
A "tech" is the shorthand we're using to describe any video playback technology - be it HTML5 video, Flash, . Basically anything that has a unique API to audio or video. Additional playback technologies can be added relatively easily.
#### [Languages](/docs/guides/languages.md)
Video.js has multi-language support! Follow this guide to see how you can contribute to and use languages.
#### [Hooks](/docs/guides/hooks.md)
A "hook" is functionality that wants to do when videojs creates a player. Right now only `beforesetup` and `setup` are supported. See the guide for more information on that.
## [API Docs][api]
You can refer to the [full list of API docs][api], but the most relevant API doc is for the [Player][api-player].
[plugins-list]: http://videojs.com/plugins
[skins-list]: https://github.com/videojs/video.js/wiki/Skins
[api]: http://docs.videojs.com/
[api-player]: http://docs.videojs.com/Player.html
[vjs-website]: http://videojs.com