Merge pull request #74 from Kocal/chore/split-jsdoc-config-files

chore(example): write a JSDoc configuration file for each template

Author: Kocal

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## NEXT
+
+### Internals
+
+- In the folder `example`, write a JSDoc configuration file for each supported template (#74)
+
 ## 2.0.1
 
 ### Fixes
@@ -19,7 +25,7 @@
 - Added [tui](https://github.com/nhnent/tui.jsdoc-template) renderer (#66)
 - Added [minami](https://github.com/nijikokun/minami) renderer (#67)
 
-### Removals 
+### Removals
 
 - Removed `followImports` config (#53)
 - Removed configuration system (#53)

example/jsdoc-docstrap.js

@@ -0,0 +1,6 @@
+const config = Object.assign({}, require('./jsdoc'));
+
+config.opts.destination = 'docs-docstrap';
+config.opts.template = './node_modules/ink-docstrap/template';
+
+module.exports = config;

example/jsdoc-minami.js

@@ -0,0 +1,6 @@
+const config = Object.assign({}, require('./jsdoc'));
+
+config.opts.destination = 'docs-minami';
+config.opts.template = './node_modules/minami';
+
+module.exports = config;

example/jsdoc-tui.js

@@ -0,0 +1,6 @@
+const config = Object.assign({}, require('./jsdoc'));
+
+config.opts.destination = 'docs-tui';
+config.opts.template = './node_modules/tui-jsdoc-template';
+
+module.exports = config;

example/jsdoc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  plugins: [
+    '../',
+    'plugins/markdown',
+  ],
+  source: {
+    include: [
+      'src/',
+      'README.md',
+    ],
+    includePattern: '\\.(vue|js)$',
+  },
+  opts: {
+    encoding: 'utf8',
+  },
+};

example/jsdoc.json

@@ -1,9 +1,9 @@
 {
   "scripts": {
-    "docs": "jsdoc -d docs -c jsdoc.json",
-    "docs:docstrap": "jsdoc -d docs-docstrap -c jsdoc.json -t ./node_modules/ink-docstrap/template",
-    "docs:minami": "jsdoc -d docs-minami -c jsdoc.json -t ./node_modules/minami",
-    "docs:tui": "jsdoc -d docs-tui -c jsdoc.json -t ./node_modules/tui-jsdoc-template"
+    "docs": "jsdoc -d docs -c jsdoc.js",
+    "docs:docstrap": "jsdoc -c jsdoc-docstrap.js",
+    "docs:minami": "jsdoc -c jsdoc-minami.js",
+    "docs:tui": "jsdoc -c jsdoc-tui.js"
   },
   "dependencies": {
     "ink-docstrap": "^1.3.2",