Skip to content

Commit a9dced2

Browse files
committed
implement type docs
1 parent 7ccf5e2 commit a9dced2

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

config/config-typedoc.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
"use strict";
2+
3+
/**
4+
* Webpack Plugins
5+
*/
6+
const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
7+
8+
/**
9+
* Typedoc config
10+
*/
11+
const configTypedoc = function () {
12+
return {
13+
plugins: [
14+
new TypedocWebpackPlugin({
15+
target: 'es6',
16+
disableOutputCheck: true
17+
}, ['./typings', './typings_custom', './src/app'])
18+
]
19+
};
20+
};
21+
module.exports = configTypedoc;

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"server:dev": "cross-env NODE_ENV=development npm run webpack-dev-server --inline --progress --profile --watch",
2828
"server:dev:hmr": "npm run server:dev -- --hot",
2929
"server:prod": "http-server dist --cors",
30+
"server:docs": "http-server dist/docs --cors",
3031
"lint": "lint:app && lint:test",
3132
"lint:app": "tslint -c ./tslint.json './src/app/**/*.ts'",
3233
"lint:test": "tslint -c ./tslint.json './test/unit/**/*.ts'",
@@ -132,6 +133,8 @@
132133
"ncp": "^2.0.0",
133134
"rimraf": "^2.5.4",
134135
"ts-node": "^1.7.0",
136+
"typedoc": "^0.5.1",
137+
"typedoc-webpack-plugin": "^1.1.3",
135138
"typescript": "^2.1",
136139
"wait-on": "2.0.1",
137140
"wallaby-webpack": "0.0.26",

webpack.config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@ module.exports = function (envArguments) {
266266
require('./config/config-globals.js')(),
267267
require('./config/config-favicon.js')(configFavicon),
268268
require('./config/config-notifier.js')(configNotifier),
269+
require('./config/config-typedoc.js')(),
269270
require('./config/config-loader-options.js')(WebpackOptionLoader().initalConfig, WebpackOptionLoader().extraction)
270271
);
271272
break;

0 commit comments

Comments
 (0)