ydeng/audioshowkit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Set up JSDoc tutorial system and dev environment.

Browse Source
This commit is contained in:
Harrison Deng 2022-04-18 08:05:41 -05:00
parent c4586d4354
commit cc6b70404b
8 changed files with 1441 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.vscode/settings.json vendored
View File

@ -7,5 +7,6 @@
"linebreak",
"songplayer"
],
"javascript.preferences.importModuleSpecifierEnding": "js"
"javascript.preferences.importModuleSpecifierEnding": "js",
"html.format.wrapLineLength": 0
}

3
jsdoc.config.json
View File

@ -7,7 +7,8 @@
},
"opts": {
"destination": "./docs",
"recurse": true
"recurse": true,
"tutorials": "./tutorials"
},
"plugins": [
"node_modules/@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer.js",

1400
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

7
package.json
View File

@ -8,11 +8,13 @@
"scripts": {
"build:prod": "webpack --config webpack.prod.cjs",
"build:dev": "webpack --config webpack.dev.cjs",
"build": "npm run build:dev",
"test:junit": "mocha tests/** --reporter mocha-junit-reporter --reporter-options mochaFile=./junit/test_results.xml",
"test:console": "mocha tests/**",
"watch:docs": "nodemon --watch dist/ --watch tutorials/ --watch src/ --exec 'npm run docs' -e js,mjs,json,htm,html,xml,markdown,md,xhtml",
"watch:lib": "webpack --watch --config webpack.dev.cjs",
"build": "npm run build:dev",
"test": "npm run test:console",
"watch": "webpack --watch --config webpack.dev.cjs",
"watch": "npm run watch:lib",
"docs": "jsdoc -c jsdoc.config.json"
},
"author": "",
@ -32,6 +34,7 @@
"jsdoc": "^3.6.10",
"mocha": "^9.2.2",
"mocha-junit-reporter": "^2.0.2",
"nodemon": "^2.0.15",
"style-loader": "^3.3.1",
"webpack": "^5.72.0",
"webpack-cli": "^4.9.2",

18
tutorials/SongPlayer.html Normal file
View File

@ -0,0 +1,18 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Creating a Song Player</title>
</head>
<body>
<div>
<h1>Creating a Song Player</h1>
<p>One of the most basic principles behind AudioShowKit is the {@link module:player/SongPlayer}. The song player acts as an easy way for developers to set up a list of songs and play them back with simple controls.</p>
</div>
</body>
</html>

14
tutorials/SongPlaylist.html Normal file
View File

@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
</body>
</html>

BIN
tutorials/assets/audio/XXI.mp3 Normal file
View File

Binary file not shown.

BIN
tutorials/assets/audio/moments.mp3 Normal file
View File

Binary file not shown.