web/video.js
1
0
Fork 0
mirror of https://github.com/videojs/video.js.git synced 2025-06-15 00:15:26 +02:00
Code Releases Activity

docs: deploy docs using netlify (#4774)

Browse Source 
This adds in the legacy docs into the repo and enables automatic deployment via netlify. The netlify-docs.js script will error out the build on netlify on master if we're not on a tagged commit so that it won't redeploy the docs unless there's a new release. If we're not on master or on master with a tagged commit, it will process with the deploy.
Also, this removes the API docs from being published with npm, fixes #4609.
This commit is contained in:
Gary Katsevman
2017-12-04 17:42:07 -05:00
committed by GitHub
parent 0f1b2606a0
commit 4dd000c809
116 changed files with 53331 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/legacy-docs/api/assets/create-doc-files.js Normal file
View File

@ -0,0 +1,68 @@
/**
* get a subset of objects in array of objects
* based on some property value
*
* @param {array} targetArray - array to search
* @param {string} objProperty - object property to search
* @param {string|number} value - value of the property to search for
* @return {array} array of objects with matching property value
*/
function getSubArray(targetArray, objProperty, value) {
var i, totalItems = targetArray.length, idxArr = [];
for (i = 0; i < totalItems; i++) {
if (targetArray[i][objProperty] === value) {
idxArr.push(targetArray[i]);
}
}
return idxArr;
}
/**
* create the HTML files for the classes
* @param {array} filenameArray - array of the filenames
*/
function createFiles(filenameArray) {
var i,
iMax = filenameArray.length,
filename,
contentStr = '<!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title></title> <script src="//use.edgefonts.net/source-code-pro.js"></script> <link href="http://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,400,700" rel="stylesheet" type="text/css"> <!-- there are many other style for highlighted code here: https://cdnjs.com/libraries/highlight.js --> <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/atelier-forest.light.min.css"> <link rel="stylesheet" type="text/css" href="css/api-docs.css"> <script type="text/javascript" src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script> </head> <body> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/highlight.min.js"></script> <script src="js/doc-data.js"></script> <script src="js/api-docs.js"></script> </body> </html>';
for (i = 0; i < iMax; i++) {
filename = filenameArray[i];
// create file with name=filename and contents=contentStr
}
}
function createFilenameArray(classData) {
var filenameArray = [],
i,
iMax = classData.length,
item,
str;
// extract the filenames from the class items
for (i = 0; i < iMax; i++) {
item = classData[i];
str = item.meta.filename;
str = str.substr(str.lastIndexOf('/') + 1);
str = str.replace('.js', '.html');
filenameArray.push(str);
}
// videojs is special case
filenameArray.push('video.html');
filenameArray = filenameArray.sort();
console.log('filenameArray', filenameArray);
// now create the files
createFiles(filenameArray);
}
/**
* extracts class items from doc data
* @param {array} docData JSON output from JSDoc
*/
function getClassData(docData) {
var classData = [];
// extract the class items from the doc data
classData = getSubArray(docData, 'kind', 'class');
// now create the array of filenames
createFilenameArray(classData);
}
getClassData(docData);