@docsector/docsector-reader 1.7.1 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.cjs +2 -0
- package/README.md +91 -9
- package/bin/docsector.js +27 -13
- package/package.json +1 -1
- package/src/components/DH1.vue +2 -1
- package/src/components/DMenu.vue +70 -30
- package/src/components/DMenuItem.vue +12 -6
- package/src/components/DPage.vue +124 -31
- package/src/components/DPageAnchor.vue +13 -1
- package/src/components/DPageBar.vue +2 -1
- package/src/components/DPageMeta.vue +9 -4
- package/src/components/DPageSection.vue +2 -1
- package/src/composables/useWebMcp.js +2 -1
- package/src/i18n/helpers.js +36 -9
- package/src/i18n/index.js +2 -2
- package/src/i18n/path.js +101 -0
- package/src/index.js +25 -2
- package/src/layouts/DefaultLayout.vue +181 -2
- package/src/pages/guide/getting-started.overview.en-US.md +3 -2
- package/src/pages/guide/getting-started.overview.pt-BR.md +3 -2
- package/src/pages/guide/pages-and-routing.overview.en-US.md +6 -6
- package/src/pages/guide/pages-and-routing.overview.pt-BR.md +6 -6
- package/src/pages/guide.book.js +12 -0
- package/src/pages/guide.index.js +184 -0
- package/src/pages/manual.book.js +12 -0
- package/src/pages/{index.js → manual.index.js} +13 -216
- package/src/quasar.factory.js +398 -56
- package/src/router/routes.js +132 -46
|
@@ -1,207 +1,4 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Docsector Reader - Pages Registry
|
|
3
|
-
*
|
|
4
|
-
* Define your documentation pages here. Each entry maps a URL path
|
|
5
|
-
* to its configuration, data (titles per language), and optional metadata.
|
|
6
|
-
*
|
|
7
|
-
* config.type: determines the top-level route prefix (e.g., 'manual', 'guide', 'API')
|
|
8
|
-
* config.status: 'done' | 'draft' | 'empty'
|
|
9
|
-
* config.meta.description: string or localized object for SEO/social description
|
|
10
|
-
* config.icon: Material Design icon name
|
|
11
|
-
* config.menu: menu display options (header, subheader, separator)
|
|
12
|
-
* config.subpages: { showcase: bool, vs: bool }
|
|
13
|
-
* data: per-language titles (use '*' for all languages)
|
|
14
|
-
* meta: per-language section/translation counts
|
|
15
|
-
*
|
|
16
|
-
* Set config to null for category nodes (non-navigable groupings).
|
|
17
|
-
*/
|
|
18
1
|
export default {
|
|
19
|
-
// =========================================================================
|
|
20
|
-
// Guides
|
|
21
|
-
// =========================================================================
|
|
22
|
-
'/getting-started': {
|
|
23
|
-
config: {
|
|
24
|
-
icon: 'flag',
|
|
25
|
-
status: 'done',
|
|
26
|
-
meta: {
|
|
27
|
-
description: {
|
|
28
|
-
'en-US': 'Getting Started — Documentation of Docsector Reader',
|
|
29
|
-
'pt-BR': 'Começando — Documentacao do Docsector Reader'
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
type: 'guide',
|
|
33
|
-
menu: {
|
|
34
|
-
header: {
|
|
35
|
-
icon: 'school',
|
|
36
|
-
label: 'Guides'
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
subpages: {
|
|
40
|
-
showcase: false
|
|
41
|
-
}
|
|
42
|
-
},
|
|
43
|
-
data: {
|
|
44
|
-
'en-US': { title: 'Getting Started' },
|
|
45
|
-
'pt-BR': { title: 'Começando' }
|
|
46
|
-
}
|
|
47
|
-
},
|
|
48
|
-
|
|
49
|
-
'/configuration': {
|
|
50
|
-
config: {
|
|
51
|
-
icon: 'tune',
|
|
52
|
-
status: 'done',
|
|
53
|
-
meta: {
|
|
54
|
-
description: {
|
|
55
|
-
'en-US': 'Configuration — Documentation of Docsector Reader',
|
|
56
|
-
'pt-BR': 'Configuração — Documentacao do Docsector Reader'
|
|
57
|
-
}
|
|
58
|
-
},
|
|
59
|
-
type: 'guide',
|
|
60
|
-
menu: {
|
|
61
|
-
separator: ' page'
|
|
62
|
-
},
|
|
63
|
-
subpages: {
|
|
64
|
-
showcase: false
|
|
65
|
-
}
|
|
66
|
-
},
|
|
67
|
-
data: {
|
|
68
|
-
'en-US': { title: 'Configuration' },
|
|
69
|
-
'pt-BR': { title: 'Configuração' }
|
|
70
|
-
}
|
|
71
|
-
},
|
|
72
|
-
|
|
73
|
-
'/pages-and-routing': {
|
|
74
|
-
config: {
|
|
75
|
-
icon: 'route',
|
|
76
|
-
status: 'done',
|
|
77
|
-
meta: {
|
|
78
|
-
description: {
|
|
79
|
-
'en-US': 'Pages & Routing — Documentation of Docsector Reader',
|
|
80
|
-
'pt-BR': 'Páginas & Rotas — Documentacao do Docsector Reader'
|
|
81
|
-
}
|
|
82
|
-
},
|
|
83
|
-
type: 'guide',
|
|
84
|
-
menu: {},
|
|
85
|
-
subpages: {
|
|
86
|
-
showcase: false
|
|
87
|
-
}
|
|
88
|
-
},
|
|
89
|
-
data: {
|
|
90
|
-
'en-US': { title: 'Pages & Routing' },
|
|
91
|
-
'pt-BR': { title: 'Páginas & Rotas' }
|
|
92
|
-
}
|
|
93
|
-
},
|
|
94
|
-
|
|
95
|
-
'/i18n-and-markdown': {
|
|
96
|
-
config: {
|
|
97
|
-
icon: 'translate',
|
|
98
|
-
status: 'done',
|
|
99
|
-
meta: {
|
|
100
|
-
description: {
|
|
101
|
-
'en-US': 'i18n & Markdown — Documentation of Docsector Reader',
|
|
102
|
-
'pt-BR': 'i18n & Markdown — Documentacao do Docsector Reader'
|
|
103
|
-
}
|
|
104
|
-
},
|
|
105
|
-
type: 'guide',
|
|
106
|
-
menu: {},
|
|
107
|
-
subpages: {
|
|
108
|
-
showcase: false
|
|
109
|
-
}
|
|
110
|
-
},
|
|
111
|
-
data: {
|
|
112
|
-
'en-US': { title: 'i18n & Markdown' },
|
|
113
|
-
'pt-BR': { title: 'i18n & Markdown' }
|
|
114
|
-
}
|
|
115
|
-
},
|
|
116
|
-
|
|
117
|
-
'/alerts-and-blockquotes': {
|
|
118
|
-
config: {
|
|
119
|
-
icon: 'notification_important',
|
|
120
|
-
status: 'done',
|
|
121
|
-
meta: {
|
|
122
|
-
description: {
|
|
123
|
-
'en-US': 'Alerts & Blockquotes — Documentation of Docsector Reader',
|
|
124
|
-
'pt-BR': 'Alertas & Blockquotes — Documentacao do Docsector Reader'
|
|
125
|
-
}
|
|
126
|
-
},
|
|
127
|
-
type: 'guide',
|
|
128
|
-
menu: {},
|
|
129
|
-
subpages: {
|
|
130
|
-
showcase: false
|
|
131
|
-
}
|
|
132
|
-
},
|
|
133
|
-
data: {
|
|
134
|
-
'en-US': { title: 'Alerts & Blockquotes' },
|
|
135
|
-
'pt-BR': { title: 'Alertas & Blockquotes' }
|
|
136
|
-
}
|
|
137
|
-
},
|
|
138
|
-
|
|
139
|
-
'/theming': {
|
|
140
|
-
config: {
|
|
141
|
-
icon: 'palette',
|
|
142
|
-
status: 'done',
|
|
143
|
-
meta: {
|
|
144
|
-
description: {
|
|
145
|
-
'en-US': 'Theming — Documentation of Docsector Reader',
|
|
146
|
-
'pt-BR': 'Temas — Documentacao do Docsector Reader'
|
|
147
|
-
}
|
|
148
|
-
},
|
|
149
|
-
type: 'guide',
|
|
150
|
-
menu: {},
|
|
151
|
-
subpages: {
|
|
152
|
-
showcase: false
|
|
153
|
-
}
|
|
154
|
-
},
|
|
155
|
-
data: {
|
|
156
|
-
'en-US': { title: 'Theming' },
|
|
157
|
-
'pt-BR': { title: 'Temas' }
|
|
158
|
-
}
|
|
159
|
-
},
|
|
160
|
-
|
|
161
|
-
'/deployment': {
|
|
162
|
-
config: {
|
|
163
|
-
icon: 'cloud_upload',
|
|
164
|
-
status: 'draft',
|
|
165
|
-
meta: {
|
|
166
|
-
description: {
|
|
167
|
-
'en-US': 'Deployment — Documentation of Docsector Reader',
|
|
168
|
-
'pt-BR': 'Deploy — Documentacao do Docsector Reader'
|
|
169
|
-
}
|
|
170
|
-
},
|
|
171
|
-
type: 'guide',
|
|
172
|
-
menu: {},
|
|
173
|
-
subpages: {
|
|
174
|
-
showcase: false
|
|
175
|
-
}
|
|
176
|
-
},
|
|
177
|
-
data: {
|
|
178
|
-
'en-US': { title: 'Deployment' },
|
|
179
|
-
'pt-BR': { title: 'Deploy' }
|
|
180
|
-
}
|
|
181
|
-
},
|
|
182
|
-
|
|
183
|
-
'/plugins': {
|
|
184
|
-
config: {
|
|
185
|
-
icon: 'extension',
|
|
186
|
-
status: 'empty',
|
|
187
|
-
meta: {
|
|
188
|
-
description: {
|
|
189
|
-
'en-US': 'Plugins — Documentation of Docsector Reader',
|
|
190
|
-
'pt-BR': 'Plugins — Documentacao do Docsector Reader'
|
|
191
|
-
}
|
|
192
|
-
},
|
|
193
|
-
type: 'guide',
|
|
194
|
-
menu: {},
|
|
195
|
-
subpages: {
|
|
196
|
-
showcase: false
|
|
197
|
-
}
|
|
198
|
-
},
|
|
199
|
-
data: {
|
|
200
|
-
'en-US': { title: 'Plugins' },
|
|
201
|
-
'pt-BR': { title: 'Plugins' }
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
|
|
205
2
|
// =========================================================================
|
|
206
3
|
// Components — Layout
|
|
207
4
|
// =========================================================================
|
|
@@ -223,7 +20,7 @@ export default {
|
|
|
223
20
|
'pt-BR': 'DPage — Documentacao do Docsector Reader'
|
|
224
21
|
}
|
|
225
22
|
},
|
|
226
|
-
|
|
23
|
+
book: 'manual',
|
|
227
24
|
menu: {
|
|
228
25
|
header: {
|
|
229
26
|
icon: 'widgets',
|
|
@@ -251,7 +48,7 @@ export default {
|
|
|
251
48
|
'pt-BR': 'DSubpage — Documentacao do Docsector Reader'
|
|
252
49
|
}
|
|
253
50
|
},
|
|
254
|
-
|
|
51
|
+
book: 'manual',
|
|
255
52
|
menu: {},
|
|
256
53
|
subpages: {
|
|
257
54
|
showcase: false
|
|
@@ -273,7 +70,7 @@ export default {
|
|
|
273
70
|
'pt-BR': 'DPageSection — Documentacao do Docsector Reader'
|
|
274
71
|
}
|
|
275
72
|
},
|
|
276
|
-
|
|
73
|
+
book: 'manual',
|
|
277
74
|
menu: {
|
|
278
75
|
separator: ' page'
|
|
279
76
|
},
|
|
@@ -300,7 +97,7 @@ export default {
|
|
|
300
97
|
'pt-BR': 'DH1 – DH6 (Títulos) — Documentacao do Docsector Reader'
|
|
301
98
|
}
|
|
302
99
|
},
|
|
303
|
-
|
|
100
|
+
book: 'manual',
|
|
304
101
|
menu: {},
|
|
305
102
|
subpages: {
|
|
306
103
|
showcase: true
|
|
@@ -322,7 +119,7 @@ export default {
|
|
|
322
119
|
'pt-BR': 'DPageSourceCode — Documentacao do Docsector Reader'
|
|
323
120
|
}
|
|
324
121
|
},
|
|
325
|
-
|
|
122
|
+
book: 'manual',
|
|
326
123
|
menu: {},
|
|
327
124
|
subpages: {
|
|
328
125
|
showcase: true
|
|
@@ -344,7 +141,7 @@ export default {
|
|
|
344
141
|
'pt-BR': 'DMermaidDiagram — Documentacao do Docsector Reader'
|
|
345
142
|
}
|
|
346
143
|
},
|
|
347
|
-
|
|
144
|
+
book: 'manual',
|
|
348
145
|
menu: {},
|
|
349
146
|
subpages: {
|
|
350
147
|
showcase: true
|
|
@@ -366,7 +163,7 @@ export default {
|
|
|
366
163
|
'pt-BR': 'DPageBlockquote — Documentacao do Docsector Reader'
|
|
367
164
|
}
|
|
368
165
|
},
|
|
369
|
-
|
|
166
|
+
book: 'manual',
|
|
370
167
|
menu: {
|
|
371
168
|
separator: ' page'
|
|
372
169
|
},
|
|
@@ -393,7 +190,7 @@ export default {
|
|
|
393
190
|
'pt-BR': 'DMenu — Documentacao do Docsector Reader'
|
|
394
191
|
}
|
|
395
192
|
},
|
|
396
|
-
|
|
193
|
+
book: 'manual',
|
|
397
194
|
menu: {},
|
|
398
195
|
subpages: {
|
|
399
196
|
showcase: false
|
|
@@ -415,7 +212,7 @@ export default {
|
|
|
415
212
|
'pt-BR': 'DPageAnchor — Documentacao do Docsector Reader'
|
|
416
213
|
}
|
|
417
214
|
},
|
|
418
|
-
|
|
215
|
+
book: 'manual',
|
|
419
216
|
menu: {},
|
|
420
217
|
subpages: {
|
|
421
218
|
showcase: false
|
|
@@ -437,7 +234,7 @@ export default {
|
|
|
437
234
|
'pt-BR': 'DPageMeta — Documentacao do Docsector Reader'
|
|
438
235
|
}
|
|
439
236
|
},
|
|
440
|
-
|
|
237
|
+
book: 'manual',
|
|
441
238
|
menu: {},
|
|
442
239
|
subpages: {
|
|
443
240
|
showcase: false
|
|
@@ -462,7 +259,7 @@ export default {
|
|
|
462
259
|
'pt-BR': 'QZoom — Documentacao do Docsector Reader'
|
|
463
260
|
}
|
|
464
261
|
},
|
|
465
|
-
|
|
262
|
+
book: 'manual',
|
|
466
263
|
menu: {
|
|
467
264
|
separator: ' page'
|
|
468
265
|
},
|
|
@@ -497,7 +294,7 @@ export default {
|
|
|
497
294
|
'pt-BR': 'useNavigator — Documentacao do Docsector Reader'
|
|
498
295
|
}
|
|
499
296
|
},
|
|
500
|
-
|
|
297
|
+
book: 'manual',
|
|
501
298
|
menu: {},
|
|
502
299
|
subpages: {
|
|
503
300
|
showcase: false
|
|
@@ -530,7 +327,7 @@ export default {
|
|
|
530
327
|
'pt-BR': 'Módulos Vuex — Documentacao do Docsector Reader'
|
|
531
328
|
}
|
|
532
329
|
},
|
|
533
|
-
|
|
330
|
+
book: 'manual',
|
|
534
331
|
menu: {},
|
|
535
332
|
subpages: {
|
|
536
333
|
showcase: false
|