-
Notifications
You must be signed in to change notification settings - Fork 34
/
docma.json
176 lines (176 loc) · 6.37 KB
/
docma.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
{
"debug": 5,
"jsdoc": {
"encoding": "utf8",
"recurse": false,
"pedantic": false,
"access": null,
"package": null,
"module": true,
"undocumented": false,
"undescribed": false,
"ignored": false,
"hierarchy": true,
"sort": "alphabetic",
"relativePath": null,
"filter": null,
"allowUnknownTags": true,
"plugins": []
},
"markdown": {
"gfm": true,
"tables": true,
"breaks": false,
"pedantic": false,
"sanitize": false,
"smartLists": true,
"smartypants": false,
"xhtml": false,
"tasks": true,
"emoji": true
},
"app": {
"title": "Docma Documentation",
"meta": null,
"base": "/docma",
"entrance": "content:home", // use "api:your-lib" to set the entrance to a JSAPI page
"routing": "path",
"server": "github",
"favicon": "./doc/favicon.ico" // local path of favicon to be copied
},
"template": {
"path": "./templates/zebra", // set to "zebra" (this path is for this repo only)
"options": {
"title": {
"label": "Docma",
"href": "."
},
"logo": { // URL String or { dark: String, light: String }
"dark": "img/docma-logo-dark.png",
"light": "img/docma-logo-light.png"
},
"sidebar": {
"enabled": true,
"outline": "tree", // "flat" | "tree"
"collapsed": false,
"toolbar": true,
"itemsFolded": false,
"itemsOverflow": "crop", // "crop" | "shrink"
"badges": true, // true | false | <string-value>
"search": true,
"animations": true
},
"symbols": {
"autoLink": true, // "internal" | "external" | true (both)
"params": "list", // "list" | "table"
"enums": "list", // "list" | "table"
"props": "list", // "list" | "table"
"meta": false
},
"contentView": {
"bookmarks": "h1,h2,h3",
"faLibs": "all" // "all" or "solid"|"regular"|"brands" or comma-separated or null
},
"navbar": {
"enabled": true,
"fixed": true,
"dark": false,
"animations": true,
"menu": [
{
// "iconClass": "fas fa-book",
"label": "Building Docs",
"items": [
{ "label": "Guide", "href": "." },
{ "separator": true },
{ "label": "Docma (Builder) API", "href": "api" },
{ "label": "Build Configuration", "href": "api/#Docma~BuildConfiguration" },
{ "separator": true },
{ "label": "Docma CLI", "href": "cli" }
]
},
{
"label": "F.A.Q.",
"href": "faq"
},
{
"iconClass": "fas fa-puzzle-piece",
"label": "Templates",
"items": [
{ "label": "Default Template - Zebra", "href": "templates/zebra" },
{ "separator": true },
{ "label": "Creating Docma Templates", "href": "templates/guide" },
{ "label": "Docma Template API", "href": "api/#Docma.Template" },
{ "separator": true },
{ "label": "Docma Web API", "href": "api/web" },
{ "label": "Docma Filters", "href": "templates/filters" }
]
},
{
// "iconClass": "fas fa-cloud-download-alt",
"label": "Download",
"items": [
{
"label": "<code>npm i docma -D</code>",
"href": "https://www.npmjs.com/package/docma",
"target": "_blank"
},
{
"label": "Docma Releases",
"href": "https://github.com/onury/docma/releases",
"target": "_blank"
},
{ "separator": true },
{
"label": "Change Log",
"href": "changelog"
}
]
},
{
"iconClass": "fab fa-lg fa-github",
"label": "",
"href": "https://github.com/onury/docma",
"target": "_blank"
}
]
}
}
},
"src": [
// API sources
// default group (docma)
// route @ api/
"./lib/Docma.js",
"./lib/Template.js",
"./lib/TemplateDoctor.js",
// grouped JS API documentation
{
// route @ api/web/
"web": [
"./lib/web/DocmaWeb.js",
"./lib/web/DocmaWeb.Route.js"
],
// route @ api/web/utils/
"web/utils": "./lib/web/DocmaWeb.Utils.js"
},
// Content sources
// markdown
"./CHANGELOG.md",
"./doc/*.md",
// "./LICENSE:md",
{
// renamed markdown (deep routes)
"templates/guide": "./doc/templates/guide.md",
"templates/filters": "./doc/templates/filters.md",
"templates/zebra": "./templates/zebra/README.md",
// renamed html file
"home": "./doc/front.html"
}
],
"assets": {
"/img": ["./doc/img/*.*"]
},
"dest": "../onury.github.io/docma",
"clean": true
}