Skip to content

Commit

Permalink
feat(docs): Experiment with doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
bmuenzenmeyer committed Oct 22, 2017
1 parent 80a8017 commit 8e1808b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions core/scripts/docs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
const doc = require('jsdoc-to-markdown');
const path = require('path');
const process = require('process');
const fs = require('fs-extra');

doc.render({
files: path.resolve(process.cwd(), './core/lib/patternlab.js')
}).then((x) => {
fs.outputFile(path.resolve(process.cwd(), './docs/README.md'), x);
});
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
},
"devDependencies": {
"eslint": "3.5.0",
"jsdoc-to-markdown": "^3.0.0",
"rewire": "2.5.2",
"tap": "7.1.2"
},
Expand Down Expand Up @@ -56,6 +57,7 @@
],
"license": "MIT",
"scripts": {
"docs": "node ./core/scripts/docs.js",
"lint": "eslint core/**/*.js",
"pretest": "npm run lint",
"test": "tap test/*_tests.js --reporter spec --coverage"
Expand Down

0 comments on commit 8e1808b

Please sign in to comment.