-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Commit
* 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
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,7 @@ | |
build/files/* | ||
build/temp/* | ||
docs/api/* | ||
docs/apistyles | ||
dev.html | ||
projects | ||
.zenflow-log | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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)); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.