JSDoc attempt
This commit is contained in:
@@ -13,7 +13,7 @@ jobs:
|
|||||||
uses: andstor/jsdoc-action@v1
|
uses: andstor/jsdoc-action@v1
|
||||||
with:
|
with:
|
||||||
source_dir: ./src
|
source_dir: ./src
|
||||||
output_dir: ./out
|
output_dir: ./docs
|
||||||
config_file: conf.json
|
config_file: jsdoc.json
|
||||||
template: minami
|
template: minami
|
||||||
front_page: README.md
|
front_page: README.md
|
||||||
+43
@@ -0,0 +1,43 @@
|
|||||||
|
{
|
||||||
|
"source": {
|
||||||
|
"includePattern": ".+\\.ts(doc|x)?$",
|
||||||
|
"excludePattern": ".+\\.(test|spec).ts"
|
||||||
|
},
|
||||||
|
"plugins": [
|
||||||
|
"plugins/markdown",
|
||||||
|
"node_modules/jsdoc-babel"
|
||||||
|
],
|
||||||
|
"babel": {
|
||||||
|
"extensions": [
|
||||||
|
"ts",
|
||||||
|
"tsx"
|
||||||
|
],
|
||||||
|
"ignore": [
|
||||||
|
"**/*.(test|spec).ts"
|
||||||
|
],
|
||||||
|
"babelrc": false,
|
||||||
|
"presets": [
|
||||||
|
[
|
||||||
|
"@babel/preset-env",
|
||||||
|
{
|
||||||
|
"targets": {
|
||||||
|
"node": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"@babel/preset-typescript"
|
||||||
|
],
|
||||||
|
"plugins": [
|
||||||
|
"@babel/proposal-class-properties",
|
||||||
|
"@babel/proposal-object-rest-spread"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"opts": {
|
||||||
|
"encoding": "utf8",
|
||||||
|
"destination": "docs/",
|
||||||
|
"recurse": true,
|
||||||
|
"verbose": true,
|
||||||
|
"pedantic": true,
|
||||||
|
"readme": "./README.md"
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user