aboutsummaryrefslogtreecommitdiff
path: root/package.json
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2019-12-23 01:08:03 +0100
committerBen Beltran <ben@nsovocal.com>2019-12-23 01:08:03 +0100
commit32ec81f6370328833fd0ba3dfe1c2974ac775973 (patch)
treeeefa1fb0fa24636e3734a3b2d066085a11825ab7 /package.json
parenta84f7dfef5c6212dfe6db14d7416b8780e2a7dc9 (diff)
Add JSDoc config
Diffstat (limited to 'package.json')
-rw-r--r--package.json10
1 files changed, 9 insertions, 1 deletions
diff --git a/package.json b/package.json
index 8c0401d..8694c4c 100644
--- a/package.json
+++ b/package.json
@@ -16,6 +16,7 @@
"main": "lib/forum",
"scripts": {
"build": "parcel build --no-source-maps ./app/index.html",
+ "document": "jsdoc2md > doc/README.md",
"lint": "eslint lib app bin",
"linthtml": "htmlhint",
"setup-hooks": "ln -s ../../scripts/git-hooks/pre-commit .git/hooks/pre-commit",
@@ -36,6 +37,7 @@
"@hapi/lab": "^21.0.0",
"eslint": "^6.7.2",
"htmlhint": "^0.11.0",
+ "jsdoc-to-markdown": "^5.0.3",
"lab-markdown-reporter": "^1.0.2",
"parcel-bundler": "^1.12.4",
"parcel-plugin-svelte": "^4.0.5",
@@ -46,5 +48,11 @@
],
"browserslist": [
"last 1 firefox version"
- ]
+ ],
+ "jsdoc2md": {
+ "files": [
+ "lib/**/*.js",
+ "config/**/*.js"
+ ]
+ }
}