mirror of
https://github.com/videojs/video.js.git
synced 2024-12-14 11:23:30 +02:00
e642295468
Use the TUI JSDoc Template to generate the jsdoc files. Also, build this out on publish.
41 lines
1.5 KiB
JSON
41 lines
1.5 KiB
JSON
{
|
|
"source": {
|
|
"include": [ "src/js/" ],
|
|
"includePattern": ".js$"
|
|
},
|
|
"opts": {
|
|
"destination": "docs/api",
|
|
"readme": "docs/index.md",
|
|
"template": "node_modules/tui-jsdoc-template",
|
|
"package": "package.json",
|
|
"recurse": true,
|
|
"tutorials": "docs/guides",
|
|
"encoding": "utf8"
|
|
},
|
|
"templates": {
|
|
"default": {
|
|
"staticFiles": {
|
|
"include": ["build/docs/"]
|
|
}
|
|
},
|
|
"logo": {
|
|
"url": "http://videojs.com/img/logo.png",
|
|
"height": "30px",
|
|
"width": "214px"
|
|
},
|
|
"name": "Video.js Documentation",
|
|
"tabNames": {
|
|
"tutorials": "Guides"
|
|
},
|
|
"footerText": "<span class='copyright'><a href='http://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='http://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='http://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"],
|
|
"markdown": {
|
|
"tags": ["example"]
|
|
}
|
|
}
|