-
Notifications
You must be signed in to change notification settings - Fork 7.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
1 parent
7b0aede
commit f05769d
Showing
73 changed files
with
367 additions
and
244 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
"use strict"; | ||
|
||
const pkg = require('./package.json'); | ||
|
||
module.exports = { | ||
source: { | ||
include: ['src/js/'], | ||
includePattern: '.js$', | ||
}, | ||
opts: { | ||
destination: 'docs/api', | ||
readme: 'docs/index.md', | ||
template: 'node_modules/clean-jsdoc-theme', | ||
package: '', | ||
recurse: true, | ||
encoding: 'utf8', | ||
theme_opts: { | ||
homepageTitle: 'Video.js API docs', | ||
menu: [ | ||
{ | ||
title: 'Video.js website', | ||
link: 'https://videojs.com', | ||
class: 'link-vjs', | ||
}, | ||
{ | ||
title: `v${pkg.version} 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'], | ||
displayModuleHeade: true, | ||
meta: [ | ||
{ | ||
name: 'name', | ||
content: 'Video.js API documentation', | ||
}, | ||
{ | ||
name: 'description', | ||
content: | ||
`Generated API documentation for the latest version of Video.js (${pkg.version}).`, | ||
}, | ||
], | ||
}, | ||
}, | ||
templates: { | ||
default: { | ||
staticFiles: { | ||
include: ['build/docs/'], | ||
}, | ||
}, | ||
}, | ||
plugins: [ | ||
'plugins/markdown', | ||
'build/jsdoc-typeof-plugin', | ||
], | ||
markdown: { | ||
tags: ['example'], | ||
idInHeadings: true, | ||
}, | ||
}; |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.