mirror of
https://github.com/videojs/video.js.git
synced 2024-11-21 17:46:35 +02:00
docs: Update jsdoc template for better usability on mobile (#8048)
* docs: Update jsdoc template for better use on mobile * add logo * add logo css * redirects should have trailing slash to avoid another redirect * add and style linnks in header, remove from footer * update theme to get rid of file list * improve doc index text * Add version number in Github link
This commit is contained in:
mister-ben
GitHub
parent
423f7ebd67
commit
c1a1f9cb5d
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,6 +2,7 @@
|
||||
build/files/*
|
||||
build/temp/*
|
||||
docs/api/*
|
||||
docs/apistyles
|
||||
dev.html
|
||||
projects
|
||||
.zenflow-log
|
||||
|
||||
78
.jsdoc.json
78
.jsdoc.json
@ -1,41 +1,71 @@
|
||||
{
|
||||
"source": {
|
||||
"include": [ "src/js/" ],
|
||||
"include": [
|
||||
"src/js/"
|
||||
],
|
||||
"includePattern": ".js$"
|
||||
},
|
||||
"opts": {
|
||||
"destination": "docs/api",
|
||||
"readme": "docs/index.md",
|
||||
"template": "node_modules/tui-jsdoc-template",
|
||||
"package": "package.json",
|
||||
"template": "node_modules/clean-jsdoc-theme",
|
||||
"package": "",
|
||||
"recurse": true,
|
||||
"tutorials": "docs/guides",
|
||||
"encoding": "utf8"
|
||||
"encoding": "utf8",
|
||||
"theme_opts": {
|
||||
"homepageTitle": "Video.js API docs",
|
||||
"menu": [
|
||||
{
|
||||
"title": "Video.js website",
|
||||
"link": "https://videojs.com",
|
||||
"class": "link-vjs"
|
||||
},
|
||||
{
|
||||
"title": "v8.0.2 source",
|
||||
"link": "https://github.com/videojs/video.js",
|
||||
"class": "link-gh"
|
||||
},
|
||||
{
|
||||
"title": "Twitter",
|
||||
"link": "https://twitter.com/videojs",
|
||||
"class": "link-tw"
|
||||
}
|
||||
],
|
||||
"favicon": "https://videojs.com/favicon.ico",
|
||||
"footer": "<span class='copyright'><a href='https://videojs.com'>Video.js</a> is a free and open source HTML5 video player. © <a href='https://brightcove.com' target='_blank'>Brightcove, Inc</a>. <a href='https://github.com/videojs/video.js/blob/master/LICENSE' class='button blue' target='_blank'>View license</a></span>",
|
||||
"include_css": [
|
||||
"./build/docs/styles/videojs.css"
|
||||
],
|
||||
"displayModuleHeader": true,
|
||||
"meta": [
|
||||
{
|
||||
"name": "name",
|
||||
"content": "Video.js API documentation"
|
||||
},
|
||||
{
|
||||
"name": "description",
|
||||
"content": "Generated API documentation for the latest version of Video.js."
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"templates": {
|
||||
"default": {
|
||||
"staticFiles": {
|
||||
"include": ["build/docs/"]
|
||||
"include": [
|
||||
"build/docs/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"logo": {
|
||||
"url": "https://videojs.com/logo-white.png",
|
||||
"height": "30px",
|
||||
"width": "214px"
|
||||
},
|
||||
"name": "Video.js Documentation",
|
||||
"tabNames": {
|
||||
"tutorials": "Guides"
|
||||
},
|
||||
"footerText": "<span class='copyright'><a href='https://videojs.com'>Video.js</a> is a free and open source HTML5 video player. © <a href='https://brightcove.com' target='_blank'>Brightcove, Inc</a>. <a href='https://github.com/videojs/video.js/blob/master/LICENSE' class='button blue' target='_blank'>View license</a></span> <ul class='other-links'><li><a href='https://videojs.com' class='button white'><i class='fa fa-external-link'></i> Video.js</a></li> <li><a href='https://twitter.com/videojs' class='button white' target='_blank'><i class='fa fa-twitter'></i> @videojs</a></li> <li><a href='https://github.com/videojs/video.js' class='button white' target='_blank'><i class='fa fa-github-alt'></i> Source</a></li> </ul>",
|
||||
"css": [
|
||||
"styles/videojs.css",
|
||||
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.css"
|
||||
]
|
||||
}
|
||||
},
|
||||
"plugins": ["plugins/markdown", "build/jsdoc-typeof-plugin"],
|
||||
"plugins": [
|
||||
"plugins/markdown",
|
||||
"build/jsdoc-typeof-plugin"
|
||||
],
|
||||
"markdown": {
|
||||
"tags": ["example"],
|
||||
"tags": [
|
||||
"example"
|
||||
],
|
||||
"idInHeadings": true
|
||||
}
|
||||
}
|
||||
}
|
||||
12
build/doc-version.js
Normal file
12
build/doc-version.js
Normal file
@ -0,0 +1,12 @@
|
||||
// Updates the "vX.X.X source" link to github in .jsdoc.json
|
||||
// that will be included in the menu of the API docs
|
||||
|
||||
const fs = require('fs');
|
||||
const jsdocConfig = require('../.jsdoc.json');
|
||||
const pkgJson = require('../package.json');
|
||||
|
||||
jsdocConfig.opts.theme_opts.menu.find(menuItem => {
|
||||
return menuItem.link === 'https://github.com/videojs/video.js';
|
||||
}).title = `v${pkgJson.version} source`;
|
||||
|
||||
fs.writeFileSync('.jsdoc.json', JSON.stringify(jsdocConfig, null, 2));
|
||||
@ -14,16 +14,53 @@ footer .copyright {
|
||||
float: left;
|
||||
}
|
||||
|
||||
footer .other-links {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
float: right;
|
||||
}
|
||||
|
||||
footer .other-links li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
footer .logo {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.sidebar-title {
|
||||
background: center / contain no-repeat url(https://videojs.com/logo-white.png);
|
||||
text-indent: -999em;
|
||||
}
|
||||
|
||||
.light .sidebar-title,
|
||||
.dark .link-vjs a:before,
|
||||
.dark .link-gh a:before,
|
||||
.dark .link-tw a:before {
|
||||
-webkit-filter: invert(80%);
|
||||
filter: invert(80%);
|
||||
}
|
||||
|
||||
.link-vjs a:before,
|
||||
.link-gh a:before,
|
||||
.link-tw a:before {
|
||||
content: "";
|
||||
display: inline-block;
|
||||
width: 1.5em;
|
||||
height: 1em;
|
||||
position: relative;
|
||||
top: 0.1em;
|
||||
}
|
||||
|
||||
.link-vjs a:before {
|
||||
background: url("data:image/svg+xml;charset=UTF-8,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 640 512'%3e%3c!--! Font Awesome Free 6.2.1 by %40fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --%3e%3cpath d='M579.8 267.7c56.5-56.5 56.5-148 0-204.5c-50-50-128.8-56.5-186.3-15.4l-1.6 1.1c-14.4 10.3-17.7 30.3-7.4 44.6s30.3 17.7 44.6 7.4l1.6-1.1c32.1-22.9 76-19.3 103.8 8.6c31.5 31.5 31.5 82.5 0 114L422.3 334.8c-31.5 31.5-82.5 31.5-114 0c-27.9-27.9-31.5-71.8-8.6-103.8l1.1-1.6c10.3-14.4 6.9-34.4-7.4-44.6s-34.4-6.9-44.6 7.4l-1.1 1.6C206.5 251.2 213 330 263 380c56.5 56.5 148 56.5 204.5 0L579.8 267.7zM60.2 244.3c-56.5 56.5-56.5 148 0 204.5c50 50 128.8 56.5 186.3 15.4l1.6-1.1c14.4-10.3 17.7-30.3 7.4-44.6s-30.3-17.7-44.6-7.4l-1.6 1.1c-32.1 22.9-76 19.3-103.8-8.6C74 372 74 321 105.5 289.5L217.7 177.2c31.5-31.5 82.5-31.5 114 0c27.9 27.9 31.5 71.8 8.6 103.9l-1.1 1.6c-10.3 14.4-6.9 34.4 7.4 44.6s34.4 6.9 44.6-7.4l1.1-1.6C433.5 260.8 427 182 377 132c-56.5-56.5-148-56.5-204.5 0L60.2 244.3z'/%3e%3c/svg%3e") no-repeat;
|
||||
}
|
||||
|
||||
.link-gh a:before {
|
||||
background: url("data:image/svg+xml;charset=UTF-8,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 480 512'%3e%3c!--! Font Awesome Free 6.2.1 by %40fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --%3e%3cpath d='M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z'/%3e%3c/svg%3e") no-repeat;
|
||||
}
|
||||
|
||||
.link-tw a:before {
|
||||
background: url("data:image/svg+xml;charset=UTF-8,%3csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3e%3c!--! Font Awesome Free 6.2.1 by %40fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --%3e%3cpath d='M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z'/%3e%3c/svg%3e") no-repeat;
|
||||
}
|
||||
|
||||
.light .navbar {
|
||||
background-color: #f7f7f7;
|
||||
border-radius: 1rem;
|
||||
|
||||
}
|
||||
|
||||
.dark .navbar {
|
||||
background-color: #222;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
@ -1,27 +1,27 @@
|
||||
# Netlify redirects to redirect old tutorial pages to new guide pages
|
||||
/tutorial-angular.html https://videojs.com/guides/angular 301!
|
||||
/tutorial-audio-tracks.html https://videojs.com/guides/audio-tracks 301!
|
||||
/tutorial-components.html https://videojs.com/guides/components 301!
|
||||
/tutorial-debugging.html https://videojs.com/guides/debugging 301!
|
||||
/tutorial-embeds.html https://videojs.com/guides/embeds 301!
|
||||
/tutorial-event-target.html https://videojs.com/guides/event-target 301!
|
||||
/tutorial-faq.html https://videojs.com/guides/faqs 301!
|
||||
/tutorial-hooks.html https://videojs.com/guides/hooks 301!
|
||||
/tutorial-languages.html https://videojs.com/guides/languages 301!
|
||||
/tutorial-layout.html https://videojs.com/guides/layout 301!
|
||||
/tutorial-live.html https://videojs.com/guides/live 301!
|
||||
/tutorial-middleware.html https://videojs.com/guides/middleware 301!
|
||||
/tutorial-modal-dialog.html https://videojs.com/guides/modal-dialog 301!
|
||||
/tutorial-options.html https://videojs.com/guides/options 301!
|
||||
/tutorial-player-workflows.html https://videojs.com/guides/player-workflows 301!
|
||||
/tutorial-plugins.html https://videojs.com/guides/plugins 301!
|
||||
/tutorial-react.html https://videojs.com/guides/react 301!
|
||||
/tutorial-setup.html https://videojs.com/guides/setup 301!
|
||||
/tutorial-skins.html https://videojs.com/guides/skins 301!
|
||||
/tutorial-tech.html https://videojs.com/guides/tech 301!
|
||||
/tutorial-text-tracks.html https://videojs.com/guides/text-tracks 301!
|
||||
/tutorial-troubleshooting.html https://videojs.com/guides/troubleshooting 301!
|
||||
/tutorial-video-tracks.html https://videojs.com/guides/video-tracks 301!
|
||||
/tutorial-videojs.html https://videojs.com/guides/videojs 301!
|
||||
/tutorial-vue.html https://videojs.com/guides/vue 301!
|
||||
/tutorial-webpack.html https://videojs.com/guides/webpack 301!
|
||||
/tutorial-angular.html https://videojs.com/guides/angular/ 301!
|
||||
/tutorial-audio-tracks.html https://videojs.com/guides/audio-tracks/ 301!
|
||||
/tutorial-components.html https://videojs.com/guides/components/ 301!
|
||||
/tutorial-debugging.html https://videojs.com/guides/debugging/ 301!
|
||||
/tutorial-embeds.html https://videojs.com/guides/embeds/ 301!
|
||||
/tutorial-event-target.html https://videojs.com/guides/event-target/ 301!
|
||||
/tutorial-faq.html https://videojs.com/guides/faqs/ 301!
|
||||
/tutorial-hooks.html https://videojs.com/guides/hooks/ 301!
|
||||
/tutorial-languages.html https://videojs.com/guides/languages/ 301!
|
||||
/tutorial-layout.html https://videojs.com/guides/layout/ 301!
|
||||
/tutorial-live.html https://videojs.com/guides/live/ 301!
|
||||
/tutorial-middleware.html https://videojs.com/guides/middleware/ 301!
|
||||
/tutorial-modal-dialog.html https://videojs.com/guides/modal-dialog/ 301!
|
||||
/tutorial-options.html https://videojs.com/guides/options/ 301!
|
||||
/tutorial-player-workflows.html https://videojs.com/guides/player-workflows/ 301!
|
||||
/tutorial-plugins.html https://videojs.com/guides/plugins/ 301!
|
||||
/tutorial-react.html https://videojs.com/guides/react/ 301!
|
||||
/tutorial-setup.html https://videojs.com/guides/setup/ 301!
|
||||
/tutorial-skins.html https://videojs.com/guides/skins/ 301!
|
||||
/tutorial-tech.html https://videojs.com/guides/tech/ 301!
|
||||
/tutorial-text-tracks.html https://videojs.com/guides/text-tracks/ 301!
|
||||
/tutorial-troubleshooting.html https://videojs.com/guides/troubleshooting/ 301!
|
||||
/tutorial-video-tracks.html https://videojs.com/guides/video-tracks/ 301!
|
||||
/tutorial-videojs.html https://videojs.com/guides/videojs/ 301!
|
||||
/tutorial-vue.html https://videojs.com/guides/vue/ 301!
|
||||
/tutorial-webpack.html https://videojs.com/guides/webpack/ 301!
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js and Angular integration
|
||||
|
||||
This guide has moved to the main videojs.com website: [AngularJS and Video.js](https://videojs.com/guides/angular/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Audio Tracks
|
||||
|
||||
This guide has moved to the main videojs.com website: [Audio Tracks](https://videojs.com/guides/audio-tracks/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Components
|
||||
|
||||
This guide has moved to the main videojs.com website: [Components](https://videojs.com/guides/components/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Debugging
|
||||
|
||||
This guide has moved to the main videojs.com website: [Debugging](https://videojs.com/guides/debugging/)
|
||||
@ -1,3 +0,0 @@
|
||||
# How to Embed the Video.js player
|
||||
|
||||
This guide has moved to the main videojs.com website: [Embed a Video.js Player](https://videojs.com/guides/embeds/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Event Target
|
||||
|
||||
This guide has moved to the main videojs.com website: [Event Target](https://videojs.com/guides/event-target/)
|
||||
@ -1,3 +0,0 @@
|
||||
# FAQ
|
||||
|
||||
This guide has moved to the main videojs.com website: [FAQs](https://videojs.com/guides/faqs/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Hooks
|
||||
|
||||
This guide has moved to the main videojs.com website: [Hooks](https://videojs.com/guides/hooks/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Languages
|
||||
|
||||
This guide has moved to the main videojs.com website: [Languages](https://videojs.com/guides/languages/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Layout
|
||||
|
||||
This guide has moved to the main videojs.com website: [Layout](https://videojs.com/guides/layout/)
|
||||
@ -1,3 +0,0 @@
|
||||
# The live user interface and API in Video.js
|
||||
|
||||
This guide has moved to the main videojs.com website: [Live Support](https://videojs.com/guides/live/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Middleware
|
||||
|
||||
This guide has moved to the main videojs.com website: [Middleware](https://videojs.com/guides/middleware/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Using the Modal Dialog Component
|
||||
|
||||
This guide has moved to the main videojs.com website: [Modal Dialogs](https://videojs.com/guides/modal-dialog/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js Options Reference
|
||||
|
||||
This guide has moved to the main videojs.com website: [Video.js Options Reference](https://videojs.com/guides/options/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Player Workflows
|
||||
|
||||
This guide has moved to the main videojs.com website: [Player Workflows](https://videojs.com/guides/player-workflows/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js Plugins
|
||||
|
||||
This guide has moved to the main videojs.com website: [Video.js Plugins](https://videojs.com/guides/plugins/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js and ReactJS integration
|
||||
|
||||
This guide has moved to the main videojs.com website: [React and Video.js](https://videojs.com/guides/react/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js Setup
|
||||
|
||||
This guide has moved to the main videojs.com website: [Video.js Setup](https://videojs.com/guides/setup/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Skins
|
||||
|
||||
This guide has moved to the main videojs.com website: [Skins](https://videojs.com/guides/skins/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Playback Technology ("Tech")
|
||||
|
||||
This guide has moved to the main videojs.com website: [Playback Technology ("Tech")](https://videojs.com/guides/tech/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Text Tracks
|
||||
|
||||
This guide has moved to the main videojs.com website: [Text Tracks](https://videojs.com/guides/text-tracks/)
|
||||
@ -1,15 +0,0 @@
|
||||
# Tracks
|
||||
|
||||
There are currently three types of tracks:
|
||||
|
||||
## [Audio Tracks](https://videojs.com/guides/audio-tracks/)
|
||||
|
||||
Audio tracks allow the selection of alternate audio for a video.
|
||||
|
||||
## [Video Tracks](https://videojs.com/guides/video-tracks/)
|
||||
|
||||
Video tracks allow the selection of alternate video content.
|
||||
|
||||
## [Text Tracks](https://videojs.com/guides/text-tracks/)
|
||||
|
||||
Text tracks are used to display subtitles and captions and add a menu for navigating between chapters in a video.
|
||||
@ -1,3 +0,0 @@
|
||||
# Troubleshooting
|
||||
|
||||
This guide has moved to the main videojs.com website: [Troubleshooting](https://videojs.com/guides/troubleshooting/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video Tracks
|
||||
|
||||
This guide has moved to the main videojs.com website: [Video Tracks](https://videojs.com/guides/video-tracks/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Usage examples for the functions on videojs
|
||||
|
||||
This guide has moved to the main videojs.com website: [videojs Functions](https://videojs.com/guides/videojs/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Video.js and Vue integration
|
||||
|
||||
This guide has moved to the main videojs.com website: [Vue and Video.js](https://videojs.com/guides/vue/)
|
||||
@ -1,3 +0,0 @@
|
||||
# Using Webpack with Video.js
|
||||
|
||||
This guide has moved to the main videojs.com website: [Webpack and Video.js](https://videojs.com/guides/webpack/)
|
||||
113
docs/index.md
113
docs/index.md
@ -1,100 +1,29 @@
|
||||
# [Video.js][vjs-website] Documentation
|
||||
# [Video.js][vjs-website] API Documentation
|
||||
|
||||
There are two categories of docs: [Guides](/docs/guides/) and [API docs][api].
|
||||
## Generated API docs
|
||||
|
||||
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.
|
||||
These [API docs][api] at [docs.videojs.com][vjs-docs] are automatically generated from the jsdoc comments in the code of the `main` branch of the [Video.js repository][vjs-gh]. You'll find specific details about functions, properties, and events.
|
||||
|
||||
## Table of Contents
|
||||
The most useful API doc to start with is usually the [Player][api-player] class.
|
||||
|
||||
* [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)
|
||||
* [Debugging](#debugging)
|
||||
* [API Docs](#api-docs)
|
||||
## Guides
|
||||
|
||||
## Resolving Issues
|
||||
More in-depth instructional [guides](vjs-guides) are found on the main [Video.js website](vjs-website). The guides explain general topics and use cases (e.g. setup).
|
||||
|
||||
### [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/)
|
||||
|
||||
### Getting Started
|
||||
|
||||
#### [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)
|
||||
|
||||
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.
|
||||
|
||||
#### [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.
|
||||
|
||||
### Customizing
|
||||
|
||||
#### [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].
|
||||
|
||||
#### [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].
|
||||
|
||||
#### [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 or a YouTube player. 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.
|
||||
|
||||
#### [Debugging](/docs/guides/debugging.md)
|
||||
|
||||
Follow this guide to see how you can use `videojs.log` for debugging purposes.
|
||||
|
||||
## [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]: https://videojs.com/plugins
|
||||
|
||||
[skins-list]: https://github.com/videojs/video.js/wiki/Skins
|
||||
|
||||
[api]: https://docs.videojs.com/
|
||||
|
||||
[api-player]: https://docs.videojs.com/Player.html
|
||||
The full list of articles is on the [guides page][vjs-guides]. If you are looking for troubleshooting information, try the [FAQ][vjs-faq] and [troubleshooting][vjs-troubleshooting] pages.
|
||||
|
||||
[vjs-website]: https://videojs.com
|
||||
|
||||
[vjs-docs]: https://docs.videojs.com
|
||||
|
||||
[vjs-gh]: https://github.com/videojs/video.js
|
||||
|
||||
[vjs-guides]: https://videojs.com/guides/
|
||||
|
||||
[vjs-faq]: https://videojs.com/guides/faqs/
|
||||
|
||||
[vjs-troubleshooting]: https://videojs.com/guides/troubleshooting/
|
||||
|
||||
[api]: https://docs.videojs.com
|
||||
|
||||
[api-player]: https://docs.videojs.com/Player.html
|
||||
|
||||
1448
package-lock.json
generated
1448
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -69,7 +69,7 @@
|
||||
"test:a11y": "node build/test-a11y.js",
|
||||
"test:unit": "karma start test/karma.conf.js",
|
||||
"docs": "npm-run-all clean docs:lint docs:api",
|
||||
"docs:api": "jsdoc -c .jsdoc.json",
|
||||
"docs:api": "node ./build/doc-version.js && jsdoc -c .jsdoc.json",
|
||||
"postdocs:api": "node ./build/fix-api-docs.js",
|
||||
"docs:lint": "remark -- './{,!(node_modules)/**/}!(CHANGELOG)*.md'",
|
||||
"docs:fix": "remark --output -- './{,!(node_modules)/**/}!(CHANGELOG)*.md'",
|
||||
@ -112,6 +112,7 @@
|
||||
"browserify": "^16.2.3",
|
||||
"chokidar-cli": "^2.1.0",
|
||||
"clean-css-cli": "^4.3.0",
|
||||
"clean-jsdoc-theme": "^4.2.1",
|
||||
"cli-table": "^0.3.1",
|
||||
"conventional-changelog-cli": "^2.0.21",
|
||||
"conventional-changelog-videojs": "^3.0.1",
|
||||
@ -158,7 +159,6 @@
|
||||
"shelljs": "^0.8.5",
|
||||
"shx": "^0.3.2",
|
||||
"sinon": "^11.1.1",
|
||||
"tui-jsdoc-template": "^1.2.2",
|
||||
"typescript": "^4.8.4",
|
||||
"uglify-js": "^3.6.0",
|
||||
"unified": "^7.0.2",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user