@docsector/docsector-reader 2.0.7 → 2.2.0
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/README.md +19 -7
- package/bin/docsector.js +28 -7
- package/docsector.config.js +13 -1
- package/package.json +1 -1
- package/src/components/DMenu.vue +241 -12
- package/src/components/DMenuItem.vue +25 -2
- package/src/components/DPageBar.vue +35 -5
- package/src/components/DPageMeta.vue +40 -26
- package/src/i18n/helpers.js +84 -18
- package/src/i18n/index.js +5 -3
- package/src/i18n/languages/en-US.hjson +14 -0
- package/src/i18n/languages/pt-BR.hjson +14 -0
- package/src/i18n/path.js +15 -2
- package/src/index.js +2 -2
- package/src/layouts/DefaultLayout.vue +16 -2
- package/src/pages/.old/v0.x/guide/getting-started.overview.en-US.md +7 -0
- package/src/pages/.old/v0.x/guide/getting-started.overview.pt-BR.md +7 -0
- package/src/pages/.old/v0.x/guide.book.js +12 -0
- package/src/pages/.old/v0.x/guide.index.js +28 -0
- package/src/pages/guide/configuration.overview.en-US.md +13 -2
- package/src/pages/guide/configuration.overview.pt-BR.md +13 -2
- package/src/pages/guide/pages-and-routing.overview.en-US.md +6 -2
- package/src/pages/guide/pages-and-routing.overview.pt-BR.md +6 -2
- package/src/pages/guide.index.js +3 -1
- package/src/pages/manual/components/d-menu.overview.en-US.md +6 -2
- package/src/pages/manual/components/d-menu.overview.pt-BR.md +6 -2
- package/src/pages/manual/components/d-page-meta.overview.en-US.md +1 -0
- package/src/pages/manual/components/d-page-meta.overview.pt-BR.md +1 -0
- package/src/pages/manual.index.js +2 -1
- package/src/quasar.factory.js +648 -91
- package/src/router/routes.js +129 -95
- package/src/store/App.js +15 -5
package/src/pages/guide.index.js
CHANGED
|
@@ -30,6 +30,7 @@ export default {
|
|
|
30
30
|
config: {
|
|
31
31
|
icon: 'tune',
|
|
32
32
|
status: 'done',
|
|
33
|
+
version: 'v2.1.0',
|
|
33
34
|
meta: {
|
|
34
35
|
description: {
|
|
35
36
|
'en-US': 'Configuration — Documentation of Docsector Reader',
|
|
@@ -53,7 +54,8 @@ export default {
|
|
|
53
54
|
'/pages-and-routing': {
|
|
54
55
|
config: {
|
|
55
56
|
icon: 'route',
|
|
56
|
-
status: '
|
|
57
|
+
status: 'new',
|
|
58
|
+
version: 'v2.1.0',
|
|
57
59
|
meta: {
|
|
58
60
|
description: {
|
|
59
61
|
'en-US': 'Pages & Routing — Documentation of Docsector Reader',
|
|
@@ -26,7 +26,11 @@ Reads from `docsector.config.js`:
|
|
|
26
26
|
- `branding.logo` — Project logo image
|
|
27
27
|
- `branding.name` — Project name text
|
|
28
28
|
- `branding.version` — Current version
|
|
29
|
-
- `branding.versions` — Version dropdown options
|
|
29
|
+
- `branding.versions` — Version dropdown options, including optional release badges
|
|
30
|
+
|
|
31
|
+
The selector keeps current docs on unprefixed routes and switches archived versions to prefixed routes. For example, current `/guide/getting-started/overview/` can switch to archived `/v0.x/guide/getting-started/overview/` when a matching page exists under `src/pages/.old/v0.x/`.
|
|
32
|
+
|
|
33
|
+
Every version object shows a badge after the version label. Released versions default to `released`; versions with `released: false` or `status: 'draft'` default to `draft`; versions with `status: 'deprecated'` or `deprecated: true` default to `deprecated` in red. The badge can be customized with `badge: { label, color, textColor }`.
|
|
30
34
|
|
|
31
35
|
## External Links
|
|
32
36
|
|
|
@@ -43,7 +47,7 @@ Each link is conditionally rendered — set to `null` in the config to hide:
|
|
|
43
47
|
|
|
44
48
|
## Page Tree
|
|
45
49
|
|
|
46
|
-
The page tree is built from the router's routes at component creation time. Routes are grouped by their basepath
|
|
50
|
+
The page tree is built from the router's routes at component creation time. Routes are filtered by active version and book, then grouped by their page basepath. Groups with a `menu.header` configuration get an expansion panel with a sticky header.
|
|
47
51
|
|
|
48
52
|
## Menu Item Grouping
|
|
49
53
|
|
|
@@ -26,7 +26,11 @@ Lê do `docsector.config.js`:
|
|
|
26
26
|
- `branding.logo` — Imagem do logo do projeto
|
|
27
27
|
- `branding.name` — Texto do nome do projeto
|
|
28
28
|
- `branding.version` — Versão atual
|
|
29
|
-
- `branding.versions` — Opções do dropdown de versão
|
|
29
|
+
- `branding.versions` — Opções do dropdown de versão, incluindo badges opcionais de release
|
|
30
|
+
|
|
31
|
+
O seletor mantém a documentação atual em rotas sem prefixo e troca versões arquivadas para rotas prefixadas. Por exemplo, `/guide/getting-started/overview/` pode trocar para `/v0.x/guide/getting-started/overview/` quando existe uma página equivalente em `src/pages/.old/v0.x/`.
|
|
32
|
+
|
|
33
|
+
Todo objeto de versão mostra um badge depois do label da versão. Versões lançadas usam `released` por padrão; versões com `released: false` ou `status: 'draft'` usam `draft`; versões com `status: 'deprecated'` ou `deprecated: true` usam `deprecated` em vermelho. O badge pode ser customizado com `badge: { label, color, textColor }`.
|
|
30
34
|
|
|
31
35
|
## Links Externos
|
|
32
36
|
|
|
@@ -43,7 +47,7 @@ Cada link é renderizado condicionalmente — defina como `null` no config para
|
|
|
43
47
|
|
|
44
48
|
## Árvore de Páginas
|
|
45
49
|
|
|
46
|
-
A árvore de páginas é construída a partir das rotas do roteador no momento de criação do componente. Rotas são
|
|
50
|
+
A árvore de páginas é construída a partir das rotas do roteador no momento de criação do componente. Rotas são filtradas pela versão e pelo book ativos, depois agrupadas pelo basepath da página. Grupos com configuração `menu.header` recebem um painel de expansão com header sticky.
|
|
47
51
|
|
|
48
52
|
## Agrupamento de Itens
|
|
49
53
|
|
|
@@ -17,6 +17,7 @@ The button label changes based on page status:
|
|
|
17
17
|
| Status | Label | Color |
|
|
18
18
|
|--------|-------|-------|
|
|
19
19
|
| `done` | "Edit this page" | White |
|
|
20
|
+
| `new` | "Edit this page" | White |
|
|
20
21
|
| `draft` | "Complete this page" | Warning (orange) |
|
|
21
22
|
| `empty` | "Start this page" | Red |
|
|
22
23
|
|
|
@@ -17,6 +17,7 @@ O label do botão muda baseado no status da página:
|
|
|
17
17
|
| Status | Label | Cor |
|
|
18
18
|
|--------|-------|-----|
|
|
19
19
|
| `done` | "Edite esta página" | Branco |
|
|
20
|
+
| `new` | "Edite esta página" | Branco |
|
|
20
21
|
| `draft` | "Complete esta página" | Warning (laranja) |
|
|
21
22
|
| `empty` | "Comece esta página" | Vermelho |
|
|
22
23
|
|