Skip to content

Commit dca847f

Browse files
committed
Add jsdoc configuration
1 parent 22817f1 commit dca847f

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.quasar
2+
.cache
23
.DS_Store
34
.thumbs.db
45
node_modules

jsdoc.json

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"opts": {
3+
"encoding": "utf8",
4+
"template": "node_modules/minami",
5+
"destination": "./docs/",
6+
"recurse": true,
7+
"verbose": true,
8+
"private": true
9+
},
10+
"tags": {
11+
"allowUnknownTags": true,
12+
"dictionaries": [
13+
"jsdoc"
14+
]
15+
},
16+
"source": {
17+
"include": [
18+
".",
19+
"package.json",
20+
"README.md"
21+
],
22+
"exclude": [
23+
".git",
24+
"node_modules",
25+
".github",
26+
".quasar",
27+
"dist",
28+
"docs"
29+
],
30+
"includePattern": "\\.(vue|js)$"
31+
},
32+
"plugins": ["plugins/markdown", "node_modules/jsdoc-vuejs"],
33+
"markdown": {
34+
"parser": "gfm",
35+
"hardwrap": true
36+
},
37+
"templates": {
38+
"cleverLinks": false,
39+
"monospaceLinks": true,
40+
"useLongnameInNav": false,
41+
"showInheritedInNav": true,
42+
"default": {
43+
"outputSourceFiles": true,
44+
"includeDate": true
45+
}
46+
}
47+
}

0 commit comments

Comments
 (0)