Skip to content

Commit f9c41b3

Browse files
committed
chore(example): switch jsdoc configuration from JSON to JavaScript
1 parent 9d99f04 commit f9c41b3

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

example/jsdoc.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
module.exports = {
2+
plugins: [
3+
'../',
4+
'plugins/markdown',
5+
],
6+
source: {
7+
include: [
8+
'src/',
9+
'README.md',
10+
],
11+
includePattern: '\\.(vue|js)$',
12+
},
13+
opts: {
14+
encoding: 'utf8',
15+
},
16+
};

example/jsdoc.json

Lines changed: 0 additions & 16 deletions
This file was deleted.

example/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"scripts": {
3-
"docs": "jsdoc -d docs -c jsdoc.json",
4-
"docs:docstrap": "jsdoc -d docs-docstrap -c jsdoc.json -t ./node_modules/ink-docstrap/template",
5-
"docs:minami": "jsdoc -d docs-minami -c jsdoc.json -t ./node_modules/minami",
6-
"docs:tui": "jsdoc -d docs-tui -c jsdoc.json -t ./node_modules/tui-jsdoc-template"
3+
"docs": "jsdoc -d docs -c jsdoc.js",
4+
"docs:docstrap": "jsdoc -d docs-docstrap -c jsdoc.js -t ./node_modules/ink-docstrap/template",
5+
"docs:minami": "jsdoc -d docs-minami -c jsdoc.js -t ./node_modules/minami",
6+
"docs:tui": "jsdoc -d docs-tui -c jsdoc.js -t ./node_modules/tui-jsdoc-template"
77
},
88
"dependencies": {
99
"ink-docstrap": "^1.3.2",

0 commit comments

Comments
 (0)