Skip to content

Commit

Permalink
docs: add typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfbecker committed Aug 25, 2018
1 parent ffcc007 commit 495ba30
Show file tree
Hide file tree
Showing 5 changed files with 176 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
/lib
/coverage/
/.nyc_output/
/docs/
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ package.json
package-lock.json
.nyc_output/
lib/
docs/
143 changes: 143 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 15 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,26 @@
"types": "lib/index.d.ts",
"files": [
"lib",
"src"
"src",
"docs"
],
"scripts": {
"build": "tsc -p .",
"test": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --require ts-node/register mocha \"src/*.test.ts\"",
"prettier": "prettier '**/{*.{js?(on),ts,yml},.*.js?(on),.*.yml}' --write --list-different",
"tslint": "tslint -t stylish -c tslint.json -p tsconfig.json './src/*.ts'",
"semantic-release": "semantic-release"
"typedoc": "typedoc --out docs --readme none --excludeExternals --tsconfig tsconfig.typedoc.json"
},
"release": {
"analyzeCommits": {
"preset": "angular",
"releaseRules": [
{
"type": "docs",
"release": "patch"
}
]
}
},
"nyc": {
"include": [
Expand Down Expand Up @@ -64,6 +76,7 @@
"ts-node": "^7.0.1",
"tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0",
"typedoc": "^0.12.0",
"typescript": "^3.0.1"
}
}
16 changes: 16 additions & 0 deletions tsconfig.typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"compilerOptions": {
"strict": true,
"target": "es2018",
"module": "es2015",
"moduleResolution": "node",
"declaration": true,
"declarationMap": false,
"sourceMap": true,
"outDir": "lib",
"allowSyntheticDefaultImports": true,
"esModuleInterop": true,
"noUnusedParameters": false,
"lib": ["es2017", "dom", "dom.iterable"]
}
}

0 comments on commit 495ba30

Please sign in to comment.