Browse Source

add README creation from jsdoc comments

mightyplow 7 years ago
parent
commit
891494003c
2 changed files with 843 additions and 60 deletions
  1. 840 60
      package-lock.json
  2. 3 0
      package.json

File diff suppressed because it is too large
+ 840 - 60
package-lock.json


+ 3 - 0
package.json

@@ -8,14 +8,17 @@
     "babel-cli": "^6.26.0",
     "babel-preset-env": "^1.6.0",
     "babel-preset-stage-2": "^6.24.1",
+    "jsdoc-to-markdown": "^3.0.0",
     "nodeunit": "^0.10.2",
     "rimraf": "^2.6.1"
   },
   "scripts": {
     "createPackageJson": "node bin/createPackageJson.js",
+    "doc": "jsdoc2md -f src/**/*.js > dist/README.md",
     "nodeunit": "nodeunit",
     "test": "babel-node node_modules/.bin/nodeunit src/**/__tests__/*.test.js",
     "build": "rimraf dist && babel src -d dist --ignore __tests__",
+    "postbuild": "npm run doc",
     "prepublish": "npm run test && npm run build && npm run createPackageJson",
     "publish": "cd dist && npm publish"
   },