@docsector/docsector-reader 3.1.0 → 3.2.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/README.md +13 -2
- package/bin/docsector.js +1 -1
- package/package.json +10 -7
- package/src/components/DH2.vue +1 -1
- package/src/components/DH3.vue +1 -1
- package/src/components/DH4.vue +1 -1
- package/src/components/DH5.vue +1 -1
- package/src/components/DH6.vue +1 -1
- package/src/components/DMenu.vue +1 -1
- package/src/components/DPage.vue +26 -6
- package/src/components/DPageAnchor.vue +3 -9
- package/src/components/DPageMeta.vue +1 -0
- package/src/components/DPageTokens.vue +5 -5
- package/src/components/page-section-tokens.js +59 -6
- package/src/composables/useNavigator.js +45 -15
- package/src/css/app.sass +12 -0
- package/src/pages/404Page.vue +2 -2
- package/src/pages/Homepage.en-US.md +3 -3
- package/src/pages/Homepage.pt-BR.md +3 -3
- package/src/pages/guide/i18n-and-markdown.overview.en-US.md +26 -4
- package/src/pages/guide/i18n-and-markdown.overview.pt-BR.md +23 -1
- package/src/pages/guide/pages-and-routing.overview.en-US.md +11 -9
- package/src/pages/guide/pages-and-routing.overview.pt-BR.md +11 -9
- package/src/pages/guide.index.js +0 -28
- package/src/pages/manual/basic/branding.overview.en-US.md +27 -0
- package/src/pages/manual/basic/branding.overview.pt-BR.md +27 -0
- package/src/pages/manual/{components → basic}/d-menu.overview.en-US.md +11 -3
- package/src/pages/manual/{components → basic}/d-menu.overview.pt-BR.md +11 -3
- package/src/pages/manual/{components → basic}/d-page-anchor.overview.en-US.md +5 -3
- package/src/pages/manual/{components → basic}/d-page-anchor.overview.pt-BR.md +5 -3
- package/src/pages/manual/{components → basic}/d-page-meta.overview.en-US.md +10 -2
- package/src/pages/manual/{components → basic}/d-page-meta.overview.pt-BR.md +10 -2
- package/src/pages/manual/basic/edit-on-github.overview.en-US.md +26 -0
- package/src/pages/manual/basic/edit-on-github.overview.pt-BR.md +26 -0
- package/src/pages/manual/basic/previous-and-next.overview.en-US.md +17 -0
- package/src/pages/manual/basic/previous-and-next.overview.pt-BR.md +17 -0
- package/src/pages/manual/basic/search.overview.en-US.md +24 -0
- package/src/pages/manual/basic/search.overview.pt-BR.md +24 -0
- package/src/pages/manual/basic/translation-progress.overview.en-US.md +19 -0
- package/src/pages/manual/basic/translation-progress.overview.pt-BR.md +19 -0
- package/src/pages/manual/basic/version-switcher.overview.en-US.md +28 -0
- package/src/pages/manual/basic/version-switcher.overview.pt-BR.md +28 -0
- package/src/pages/manual/components/d-subpage.overview.en-US.md +2 -2
- package/src/pages/manual/components/d-subpage.overview.pt-BR.md +2 -2
- package/src/pages/manual/content/blocks/code-blocks.overview.en-US.md +55 -0
- package/src/pages/manual/content/blocks/code-blocks.overview.pt-BR.md +55 -0
- package/src/pages/manual/{components/d-page-source-code.showcase.en-US.md → content/blocks/code-blocks.showcase.en-US.md} +14 -12
- package/src/pages/manual/{components/d-page-source-code.showcase.pt-BR.md → content/blocks/code-blocks.showcase.pt-BR.md} +28 -26
- package/src/pages/manual/{components/d-page-expandable.overview.en-US.md → content/blocks/expandable.overview.en-US.md} +3 -12
- package/src/pages/manual/{components/d-page-expandable.overview.pt-BR.md → content/blocks/expandable.overview.pt-BR.md} +3 -12
- package/src/pages/manual/content/blocks/headings.overview.en-US.md +45 -0
- package/src/pages/manual/content/blocks/headings.overview.pt-BR.md +45 -0
- package/src/pages/manual/{components/d-headings.showcase.en-US.md → content/blocks/headings.showcase.en-US.md} +1 -1
- package/src/pages/manual/{components/d-headings.showcase.pt-BR.md → content/blocks/headings.showcase.pt-BR.md} +1 -1
- package/src/pages/manual/content/blocks/hints.overview.en-US.md +30 -0
- package/src/pages/manual/content/blocks/hints.overview.pt-BR.md +30 -0
- package/src/pages/manual/content/blocks/hints.showcase.en-US.md +30 -0
- package/src/pages/manual/content/blocks/hints.showcase.pt-BR.md +30 -0
- package/src/pages/manual/content/blocks/images.overview.en-US.md +16 -0
- package/src/pages/manual/content/blocks/images.overview.pt-BR.md +16 -0
- package/src/pages/manual/content/blocks/images.showcase.en-US.md +11 -0
- package/src/pages/manual/content/blocks/images.showcase.pt-BR.md +11 -0
- package/src/pages/manual/content/blocks/math-and-tex.overview.en-US.md +27 -0
- package/src/pages/manual/content/blocks/math-and-tex.overview.pt-BR.md +27 -0
- package/src/pages/manual/content/blocks/math-and-tex.showcase.en-US.md +14 -0
- package/src/pages/manual/content/blocks/math-and-tex.showcase.pt-BR.md +14 -0
- package/src/pages/manual/content/blocks/mermaid-diagrams.overview.en-US.md +22 -0
- package/src/pages/manual/content/blocks/mermaid-diagrams.overview.pt-BR.md +22 -0
- package/src/pages/manual/content/blocks/ordered-lists.overview.en-US.md +19 -0
- package/src/pages/manual/content/blocks/ordered-lists.overview.pt-BR.md +19 -0
- package/src/pages/manual/content/blocks/ordered-lists.showcase.en-US.md +21 -0
- package/src/pages/manual/content/blocks/ordered-lists.showcase.pt-BR.md +21 -0
- package/src/pages/manual/content/blocks/paragraphs.overview.en-US.md +19 -0
- package/src/pages/manual/content/blocks/paragraphs.overview.pt-BR.md +19 -0
- package/src/pages/manual/content/blocks/paragraphs.showcase.en-US.md +9 -0
- package/src/pages/manual/content/blocks/paragraphs.showcase.pt-BR.md +9 -0
- package/src/pages/manual/content/blocks/quick-links.overview.en-US.md +28 -0
- package/src/pages/manual/content/blocks/quick-links.overview.pt-BR.md +28 -0
- package/src/pages/manual/content/blocks/quick-links.showcase.en-US.md +34 -0
- package/src/pages/manual/content/blocks/quick-links.showcase.pt-BR.md +34 -0
- package/src/pages/manual/content/blocks/quotes.overview.en-US.md +24 -0
- package/src/pages/manual/content/blocks/quotes.overview.pt-BR.md +24 -0
- package/src/pages/manual/content/blocks/quotes.showcase.en-US.md +17 -0
- package/src/pages/manual/content/blocks/quotes.showcase.pt-BR.md +17 -0
- package/src/pages/manual/content/blocks/raw-html.overview.en-US.md +19 -0
- package/src/pages/manual/content/blocks/raw-html.overview.pt-BR.md +19 -0
- package/src/pages/manual/content/blocks/raw-html.showcase.en-US.md +12 -0
- package/src/pages/manual/content/blocks/raw-html.showcase.pt-BR.md +12 -0
- package/src/pages/manual/content/blocks/tables.overview.en-US.md +19 -0
- package/src/pages/manual/content/blocks/tables.overview.pt-BR.md +19 -0
- package/src/pages/manual/content/blocks/tables.showcase.en-US.md +17 -0
- package/src/pages/manual/content/blocks/tables.showcase.pt-BR.md +17 -0
- package/src/pages/manual/content/blocks/unordered-lists.overview.en-US.md +21 -0
- package/src/pages/manual/content/blocks/unordered-lists.overview.pt-BR.md +21 -0
- package/src/pages/manual/content/blocks/unordered-lists.showcase.en-US.md +24 -0
- package/src/pages/manual/content/blocks/unordered-lists.showcase.pt-BR.md +24 -0
- package/src/pages/manual/content/structures/books.overview.en-US.md +36 -0
- package/src/pages/manual/content/structures/books.overview.pt-BR.md +36 -0
- package/src/pages/manual/content/structures/page.overview.en-US.md +61 -0
- package/src/pages/manual/content/structures/page.overview.pt-BR.md +61 -0
- package/src/pages/manual/content/structures/subpage.overview.en-US.md +62 -0
- package/src/pages/manual/content/structures/subpage.overview.pt-BR.md +62 -0
- package/src/pages/manual.index.js +487 -153
- package/src/router/routes.js +1 -1
- package/src/pages/guide/alerts-and-blockquotes.overview.en-US.md +0 -65
- package/src/pages/guide/alerts-and-blockquotes.overview.pt-BR.md +0 -65
- package/src/pages/manual/components/d-headings.overview.en-US.md +0 -54
- package/src/pages/manual/components/d-headings.overview.pt-BR.md +0 -54
- package/src/pages/manual/components/d-mermaid-diagram.overview.en-US.md +0 -31
- package/src/pages/manual/components/d-mermaid-diagram.overview.pt-BR.md +0 -29
- package/src/pages/manual/components/d-page-blockquote.overview.en-US.md +0 -66
- package/src/pages/manual/components/d-page-blockquote.overview.pt-BR.md +0 -66
- package/src/pages/manual/components/d-page-blockquote.showcase.en-US.md +0 -34
- package/src/pages/manual/components/d-page-blockquote.showcase.pt-BR.md +0 -34
- package/src/pages/manual/components/d-page-section.overview.en-US.md +0 -57
- package/src/pages/manual/components/d-page-section.overview.pt-BR.md +0 -57
- package/src/pages/manual/components/d-page-section.showcase.en-US.md +0 -43
- package/src/pages/manual/components/d-page-section.showcase.pt-BR.md +0 -43
- package/src/pages/manual/components/d-page-source-code.overview.en-US.md +0 -68
- package/src/pages/manual/components/d-page-source-code.overview.pt-BR.md +0 -68
- package/src/pages/manual/components/d-page.overview.en-US.md +0 -59
- package/src/pages/manual/components/d-page.overview.pt-BR.md +0 -59
- package/src/pages/manual/components/d-page.showcase.en-US.md +0 -35
- package/src/pages/manual/components/d-page.showcase.pt-BR.md +0 -35
- package/src/pages/manual/components/q-zoom.overview.en-US.md +0 -71
- package/src/pages/manual/components/q-zoom.overview.pt-BR.md +0 -71
- package/src/pages/manual/composables/use-navigator.overview.en-US.md +0 -89
- package/src/pages/manual/composables/use-navigator.overview.pt-BR.md +0 -89
- package/src/pages/manual/store/modules.overview.en-US.md +0 -96
- package/src/pages/manual/store/modules.overview.pt-BR.md +0 -96
- /package/src/pages/manual/{components/d-page-expandable.showcase.en-US.md → content/blocks/expandable.showcase.en-US.md} +0 -0
- /package/src/pages/manual/{components/d-page-expandable.showcase.pt-BR.md → content/blocks/expandable.showcase.pt-BR.md} +0 -0
- /package/src/pages/manual/{components/d-mermaid-diagram.showcase.en-US.md → content/blocks/mermaid-diagrams.showcase.en-US.md} +0 -0
- /package/src/pages/manual/{components/d-mermaid-diagram.showcase.pt-BR.md → content/blocks/mermaid-diagrams.showcase.pt-BR.md} +0 -0
|
@@ -41,9 +41,15 @@ The `_` object is the root namespace for pages. Page titles and content are **au
|
|
|
41
41
|
|
|
42
42
|
Documentation content is written in standard Markdown with some conventions:
|
|
43
43
|
|
|
44
|
+
See the dedicated manual pages for block-by-block reference:
|
|
45
|
+
|
|
46
|
+
- [Paragraphs](/manual/content/blocks/paragraphs/overview/), [Headings](/manual/content/blocks/headings/overview/), [Unordered lists](/manual/content/blocks/unordered-lists/overview/), [Ordered lists](/manual/content/blocks/ordered-lists/overview/)
|
|
47
|
+
- [Hints](/manual/content/blocks/hints/overview/), [Quote](/manual/content/blocks/quotes/overview/), [Code blocks](/manual/content/blocks/code-blocks/overview/), [Mermaid diagrams](/manual/content/blocks/mermaid-diagrams/overview/)
|
|
48
|
+
- [Images](/manual/content/blocks/images/overview/), [Math & TeX](/manual/content/blocks/math-and-tex/overview/), [Expandable](/manual/content/blocks/expandable/overview/), [Tables](/manual/content/blocks/tables/overview/), [Raw HTML](/manual/content/blocks/raw-html/overview/), and [Quick Links](/manual/content/blocks/quick-links/overview/)
|
|
49
|
+
|
|
44
50
|
### Headings
|
|
45
51
|
|
|
46
|
-
Use `##` through `######` for section headings. Each heading becomes a navigation anchor in the ToC tree.
|
|
52
|
+
Use `##` through `######` for section headings. Each heading becomes a navigation anchor in the ToC tree using a GitHub-compatible slug, so standard README fragments such as `#table-of-contents` work in Docsector too.
|
|
47
53
|
|
|
48
54
|
### Code Blocks
|
|
49
55
|
|
|
@@ -61,6 +67,25 @@ You can render Mermaid diagrams using fenced blocks with the `mermaid` language
|
|
|
61
67
|
```
|
|
62
68
|
```mermaid
|
|
63
69
|
flowchart TD
|
|
70
|
+
A[Start] --> B[End]
|
|
71
|
+
```
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Math and TeX
|
|
75
|
+
|
|
76
|
+
Docsector supports KaTeX-style math in standard Markdown flows, including paragraphs, alerts, and expandable content.
|
|
77
|
+
|
|
78
|
+
Use single dollar delimiters for inline math such as $E = mc^2$.
|
|
79
|
+
|
|
80
|
+
Use double dollar delimiters for display math:
|
|
81
|
+
|
|
82
|
+
```markdown
|
|
83
|
+
$$
|
|
84
|
+
\int_0^1 x^2 dx
|
|
85
|
+
$$
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Math delimiters remain literal inside inline code and fenced code blocks, so syntax examples can be documented without rendering the equation.
|
|
64
89
|
|
|
65
90
|
### GitHub Alerts
|
|
66
91
|
|
|
@@ -75,9 +100,6 @@ Docsector also supports GitHub-style alert blockquotes:
|
|
|
75
100
|
|
|
76
101
|
Supported types are `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, and `CAUTION`.
|
|
77
102
|
Regular blockquotes (without `[!TYPE]`) continue to work as normal.
|
|
78
|
-
A[Start] --> B[End]
|
|
79
|
-
```
|
|
80
|
-
```
|
|
81
103
|
|
|
82
104
|
### Custom Attributes
|
|
83
105
|
|
|
@@ -41,9 +41,15 @@ O objeto `_` é o namespace raiz para páginas. Títulos e conteúdo das página
|
|
|
41
41
|
|
|
42
42
|
O conteúdo da documentação é escrito em Markdown padrão com algumas convenções:
|
|
43
43
|
|
|
44
|
+
Veja também as páginas dedicadas do manual para cada bloco:
|
|
45
|
+
|
|
46
|
+
- [Parágrafos](/manual/content/blocks/paragraphs/overview/), [Títulos](/manual/content/blocks/headings/overview/), [Listas não ordenadas](/manual/content/blocks/unordered-lists/overview/), [Listas ordenadas](/manual/content/blocks/ordered-lists/overview/)
|
|
47
|
+
- [Hints](/manual/content/blocks/hints/overview/), [Citação](/manual/content/blocks/quotes/overview/), [Blocos de código](/manual/content/blocks/code-blocks/overview/), [Diagramas Mermaid](/manual/content/blocks/mermaid-diagrams/overview/)
|
|
48
|
+
- [Imagens](/manual/content/blocks/images/overview/), [Math & TeX](/manual/content/blocks/math-and-tex/overview/), [Expansível](/manual/content/blocks/expandable/overview/), [Tabelas](/manual/content/blocks/tables/overview/), [HTML bruto](/manual/content/blocks/raw-html/overview/) e [Quick Links](/manual/content/blocks/quick-links/overview/)
|
|
49
|
+
|
|
44
50
|
### Títulos
|
|
45
51
|
|
|
46
|
-
Use `##` até `######` para títulos de seção. Cada título se torna uma âncora de navegação na árvore de ToC.
|
|
52
|
+
Use `##` até `######` para títulos de seção. Cada título se torna uma âncora de navegação na árvore de ToC usando slug compatível com GitHub, então fragmentos padrão de README como `#table-of-contents` também funcionam no Docsector.
|
|
47
53
|
|
|
48
54
|
### Blocos de Código
|
|
49
55
|
|
|
@@ -65,6 +71,22 @@ flowchart TD
|
|
|
65
71
|
```
|
|
66
72
|
```
|
|
67
73
|
|
|
74
|
+
### Math e TeX
|
|
75
|
+
|
|
76
|
+
O Docsector suporta fórmulas com KaTeX nos fluxos normais de Markdown, incluindo parágrafos, alertas e conteúdo expansível.
|
|
77
|
+
|
|
78
|
+
Use delimitadores com um dólar para fórmulas inline, como $E = mc^2$.
|
|
79
|
+
|
|
80
|
+
Use delimitadores com dois dólares para fórmulas em bloco:
|
|
81
|
+
|
|
82
|
+
```markdown
|
|
83
|
+
$$
|
|
84
|
+
\int_0^1 x^2 dx
|
|
85
|
+
$$
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Os delimitadores matemáticos permanecem literais dentro de código inline e fenced code, então exemplos de sintaxe podem ser documentados sem renderizar a equação.
|
|
89
|
+
|
|
68
90
|
### Alertas do GitHub
|
|
69
91
|
|
|
70
92
|
O Docsector tambem suporta blockquotes de alerta no estilo do GitHub:
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Documentation pages are defined in split registries such as `src/pages/guide.index.js` and `src/pages/manual.index.js`. Each entry maps a URL path to its configuration, translatable data, and optional metadata.
|
|
4
4
|
|
|
5
|
+
In the current manual, it is common to keep core UI references under `/basic`, end-user content blocks under `/content/blocks`, structural concepts under `/content/structures`, and legacy engine-facing aliases under `/components`.
|
|
6
|
+
|
|
5
7
|
## Page Entry Structure
|
|
6
8
|
|
|
7
9
|
```javascript
|
|
@@ -35,11 +37,11 @@ Documentation pages are defined in split registries such as `src/pages/guide.ind
|
|
|
35
37
|
Set `config: null` to create a non-navigable grouping node. This is useful for creating section titles in the sidebar menu:
|
|
36
38
|
|
|
37
39
|
```javascript
|
|
38
|
-
'/
|
|
40
|
+
'/content/blocks': {
|
|
39
41
|
config: null,
|
|
40
42
|
data: {
|
|
41
|
-
'en-US': { title: '
|
|
42
|
-
'pt-BR': { title: '
|
|
43
|
+
'en-US': { title: 'Blocks' },
|
|
44
|
+
'pt-BR': { title: 'Blocos' }
|
|
43
45
|
}
|
|
44
46
|
}
|
|
45
47
|
```
|
|
@@ -51,8 +53,8 @@ Pages are grouped in the sidebar by their **basepath** (second URL segment). The
|
|
|
51
53
|
```javascript
|
|
52
54
|
menu: {
|
|
53
55
|
header: {
|
|
54
|
-
icon: '
|
|
55
|
-
label: '
|
|
56
|
+
icon: 'notes',
|
|
57
|
+
label: 'Content'
|
|
56
58
|
}
|
|
57
59
|
}
|
|
58
60
|
```
|
|
@@ -72,11 +74,11 @@ Each page requires Markdown files following this naming pattern:
|
|
|
72
74
|
|
|
73
75
|
`src/pages/{book}/{path}.{subpage}.{lang}.md`
|
|
74
76
|
|
|
75
|
-
For example, a page at `/
|
|
77
|
+
For example, a page at `/content/blocks/headings` with book `manual`:
|
|
76
78
|
|
|
77
|
-
- `src/pages/manual/
|
|
78
|
-
- `src/pages/manual/
|
|
79
|
-
- `src/pages/manual/
|
|
79
|
+
- `src/pages/manual/content/blocks/headings.overview.en-US.md`
|
|
80
|
+
- `src/pages/manual/content/blocks/headings.overview.pt-BR.md`
|
|
81
|
+
- `src/pages/manual/content/blocks/headings.showcase.en-US.md` (if showcase enabled)
|
|
80
82
|
|
|
81
83
|
## Route Generation
|
|
82
84
|
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
As páginas de documentação são definidas em registros separados, como `src/pages/guide.index.js` e `src/pages/manual.index.js`. Cada entrada mapeia um caminho URL para sua configuração, dados traduzíveis e metadata opcional.
|
|
4
4
|
|
|
5
|
+
No manual atual, é comum manter referências centrais de UI sob `/basic`, blocos de conteúdo voltados ao usuário final sob `/content/blocks`, conceitos estruturais sob `/content/structures` e aliases legados voltados à engine sob `/components`.
|
|
6
|
+
|
|
5
7
|
## Estrutura de uma Entrada
|
|
6
8
|
|
|
7
9
|
```javascript
|
|
@@ -35,11 +37,11 @@ As páginas de documentação são definidas em registros separados, como `src/p
|
|
|
35
37
|
Defina `config: null` para criar um nó de agrupamento não-navegável. Útil para criar títulos de seção no menu lateral:
|
|
36
38
|
|
|
37
39
|
```javascript
|
|
38
|
-
'/
|
|
40
|
+
'/content/blocks': {
|
|
39
41
|
config: null,
|
|
40
42
|
data: {
|
|
41
|
-
'en-US': { title: '
|
|
42
|
-
'pt-BR': { title: '
|
|
43
|
+
'en-US': { title: 'Blocks' },
|
|
44
|
+
'pt-BR': { title: 'Blocos' }
|
|
43
45
|
}
|
|
44
46
|
}
|
|
45
47
|
```
|
|
@@ -51,8 +53,8 @@ Páginas são agrupadas no menu lateral pelo seu **basepath** (segundo segmento
|
|
|
51
53
|
```javascript
|
|
52
54
|
menu: {
|
|
53
55
|
header: {
|
|
54
|
-
icon: '
|
|
55
|
-
label: '
|
|
56
|
+
icon: 'notes',
|
|
57
|
+
label: 'Conteúdo'
|
|
56
58
|
}
|
|
57
59
|
}
|
|
58
60
|
```
|
|
@@ -72,11 +74,11 @@ Cada página requer arquivos Markdown seguindo este padrão de nomenclatura:
|
|
|
72
74
|
|
|
73
75
|
`src/pages/{book}/{path}.{subpage}.{lang}.md`
|
|
74
76
|
|
|
75
|
-
Por exemplo, uma página em `/
|
|
77
|
+
Por exemplo, uma página em `/content/blocks/headings` com book `manual`:
|
|
76
78
|
|
|
77
|
-
- `src/pages/manual/
|
|
78
|
-
- `src/pages/manual/
|
|
79
|
-
- `src/pages/manual/
|
|
79
|
+
- `src/pages/manual/content/blocks/headings.overview.en-US.md`
|
|
80
|
+
- `src/pages/manual/content/blocks/headings.overview.pt-BR.md`
|
|
81
|
+
- `src/pages/manual/content/blocks/headings.showcase.en-US.md` (se showcase habilitado)
|
|
80
82
|
|
|
81
83
|
## Geração de Rotas
|
|
82
84
|
|
package/src/pages/guide.index.js
CHANGED
|
@@ -120,34 +120,6 @@ export default {
|
|
|
120
120
|
}
|
|
121
121
|
},
|
|
122
122
|
|
|
123
|
-
'/alerts-and-blockquotes': {
|
|
124
|
-
config: {
|
|
125
|
-
icon: 'notification_important',
|
|
126
|
-
status: 'done',
|
|
127
|
-
meta: {
|
|
128
|
-
description: {
|
|
129
|
-
'en-US': 'Alerts & Blockquotes — Documentation of Docsector Reader',
|
|
130
|
-
'pt-BR': 'Alertas & Blockquotes — Documentacao do Docsector Reader'
|
|
131
|
-
}
|
|
132
|
-
},
|
|
133
|
-
book: 'guide',
|
|
134
|
-
menu: {},
|
|
135
|
-
subpages: {
|
|
136
|
-
showcase: false
|
|
137
|
-
}
|
|
138
|
-
},
|
|
139
|
-
data: {
|
|
140
|
-
'en-US': { title: 'Alerts & Blockquotes' },
|
|
141
|
-
'pt-BR': { title: 'Alertas & Blockquotes' }
|
|
142
|
-
},
|
|
143
|
-
metadata: {
|
|
144
|
-
tags: {
|
|
145
|
-
'en-US': 'alerts blockquotes github note tip important warning caution markdown quote admonition',
|
|
146
|
-
'pt-BR': 'alertas blockquotes github note tip important warning caution markdown citação admonition'
|
|
147
|
-
}
|
|
148
|
-
}
|
|
149
|
-
},
|
|
150
|
-
|
|
151
123
|
'/theming': {
|
|
152
124
|
config: {
|
|
153
125
|
icon: 'palette',
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Branding controls the visual identity and quick-access links shown at the top of the documentation menu.
|
|
4
|
+
|
|
5
|
+
It covers the project logo, name, current version label, and the external links that appear below the branding block.
|
|
6
|
+
|
|
7
|
+
## Main Configuration
|
|
8
|
+
|
|
9
|
+
Branding data comes from `docsector.config.js`:
|
|
10
|
+
|
|
11
|
+
- `branding.logo`
|
|
12
|
+
- `branding.name`
|
|
13
|
+
- `branding.version`
|
|
14
|
+
- `links.github`, `links.discussions`, `links.chat`, `links.email`
|
|
15
|
+
- `links.changelog`, `links.roadmap`, `links.sponsor`, `links.explore`
|
|
16
|
+
|
|
17
|
+
## What Readers Notice
|
|
18
|
+
|
|
19
|
+
- A recognizable project identity in the menu
|
|
20
|
+
- Faster access to repository and community links
|
|
21
|
+
- A stable place to understand which docs set they are reading
|
|
22
|
+
|
|
23
|
+
## Notes
|
|
24
|
+
|
|
25
|
+
- Set a link to `null` to hide it from the menu.
|
|
26
|
+
- A square or near-square logo usually fits best in the sidebar.
|
|
27
|
+
- Keep the visible project name short enough to scan quickly.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Branding controla a identidade visual e os links de acesso rápido exibidos no topo do menu da documentação.
|
|
4
|
+
|
|
5
|
+
Ele cobre o logo do projeto, o nome, o label da versão atual e os links externos que aparecem abaixo do bloco de branding.
|
|
6
|
+
|
|
7
|
+
## Configuração Principal
|
|
8
|
+
|
|
9
|
+
Os dados de branding vêm de `docsector.config.js`:
|
|
10
|
+
|
|
11
|
+
- `branding.logo`
|
|
12
|
+
- `branding.name`
|
|
13
|
+
- `branding.version`
|
|
14
|
+
- `links.github`, `links.discussions`, `links.chat`, `links.email`
|
|
15
|
+
- `links.changelog`, `links.roadmap`, `links.sponsor`, `links.explore`
|
|
16
|
+
|
|
17
|
+
## O Que o Leitor Percebe
|
|
18
|
+
|
|
19
|
+
- Uma identidade reconhecível do projeto no menu
|
|
20
|
+
- Acesso mais rápido ao repositório e aos links da comunidade
|
|
21
|
+
- Um lugar estável para entender qual conjunto de docs está sendo lido
|
|
22
|
+
|
|
23
|
+
## Observações
|
|
24
|
+
|
|
25
|
+
- Defina um link como `null` para escondê-lo do menu.
|
|
26
|
+
- Um logo quadrado ou quase quadrado costuma funcionar melhor na barra lateral.
|
|
27
|
+
- Mantenha o nome visível do projeto curto o suficiente para leitura rápida.
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
## Overview
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Navigation Menu is the **left sidebar** used to explore the documentation.
|
|
4
|
+
|
|
5
|
+
Under the hood, this page describes the `DMenu` implementation.
|
|
6
|
+
|
|
7
|
+
## Focused Pages in Basic
|
|
8
|
+
|
|
9
|
+
- [Search](/manual/basic/search/overview/)
|
|
10
|
+
- [Branding](/manual/basic/branding/overview/)
|
|
11
|
+
- [Version Switcher](/manual/basic/version-switcher/overview/)
|
|
4
12
|
|
|
5
13
|
## Features
|
|
6
14
|
|
|
@@ -21,7 +29,7 @@ Search is debounced by 300ms and supports the current locale with en-US fallback
|
|
|
21
29
|
|
|
22
30
|
## Branding Section
|
|
23
31
|
|
|
24
|
-
|
|
32
|
+
The menu reads its branding data from `docsector.config.js`:
|
|
25
33
|
|
|
26
34
|
- `branding.logo` — Project logo image
|
|
27
35
|
- `branding.name` — Project name text
|
|
@@ -60,4 +68,4 @@ Items without a header are displayed as standalone entries.
|
|
|
60
68
|
|
|
61
69
|
## Auto-Scroll
|
|
62
70
|
|
|
63
|
-
On mount and after navigation,
|
|
71
|
+
On mount and after navigation, the menu automatically scrolls to the currently active item, centering it in the viewport with a smooth 300ms animation.
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
## Visão Geral
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Menu de Navegação é a **barra lateral esquerda** usada para explorar a documentação.
|
|
4
|
+
|
|
5
|
+
Na implementação, esta página descreve o `DMenu`.
|
|
6
|
+
|
|
7
|
+
## Páginas Focadas no Basic
|
|
8
|
+
|
|
9
|
+
- [Busca](/manual/basic/search/overview/)
|
|
10
|
+
- [Branding](/manual/basic/branding/overview/)
|
|
11
|
+
- [Seletor de Versão](/manual/basic/version-switcher/overview/)
|
|
4
12
|
|
|
5
13
|
## Funcionalidades
|
|
6
14
|
|
|
@@ -21,7 +29,7 @@ A busca tem debounce de 300ms e suporta o locale atual com fallback para en-US.
|
|
|
21
29
|
|
|
22
30
|
## Seção de Branding
|
|
23
31
|
|
|
24
|
-
|
|
32
|
+
O menu lê seus dados de branding a partir de `docsector.config.js`:
|
|
25
33
|
|
|
26
34
|
- `branding.logo` — Imagem do logo do projeto
|
|
27
35
|
- `branding.name` — Texto do nome do projeto
|
|
@@ -60,4 +68,4 @@ Itens sem header são exibidos como entradas independentes.
|
|
|
60
68
|
|
|
61
69
|
## Auto-Scroll
|
|
62
70
|
|
|
63
|
-
No mount e após navegação,
|
|
71
|
+
No mount e após navegação, o menu automaticamente faz scroll até o item ativo, centralizando-o no viewport com uma animação suave de 300ms.
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
## Overview
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Table of Contents is the **right-side navigation tree** that lists the headings of the current page.
|
|
4
|
+
|
|
5
|
+
Under the hood, this behavior is powered by `DPageAnchor`.
|
|
4
6
|
|
|
5
7
|
## How It Works
|
|
6
8
|
|
|
@@ -11,7 +13,7 @@
|
|
|
11
13
|
|
|
12
14
|
## Store Integration
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
The implementation interacts with these store state/getters:
|
|
15
17
|
|
|
16
18
|
- `page/nodes` — The tree structure of headings
|
|
17
19
|
- `page/nodesExpanded` — Which tree nodes are expanded
|
|
@@ -37,7 +39,7 @@ The root node (from DH1) shows the page title from i18n when no label is set:
|
|
|
37
39
|
|
|
38
40
|
## Scroll Synchronization
|
|
39
41
|
|
|
40
|
-
When the user scrolls the page content, the `DPage` scroll observer calls `useNavigator().scrolling()`, which iterates over registered anchors and selects the one closest to the current scroll position. This keeps the
|
|
42
|
+
When the user scrolls the page content, the `DPage` scroll observer calls `useNavigator().scrolling()`, which iterates over registered anchors and selects the one closest to the current scroll position. This keeps the table of contents in sync with the visible content.
|
|
41
43
|
|
|
42
44
|
## Lifecycle
|
|
43
45
|
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
## Visão Geral
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Índice da Página é a **árvore de navegação lateral direita** que lista os títulos da página atual.
|
|
4
|
+
|
|
5
|
+
Na implementação, esse comportamento é sustentado por `DPageAnchor`.
|
|
4
6
|
|
|
5
7
|
## Como Funciona
|
|
6
8
|
|
|
@@ -11,7 +13,7 @@
|
|
|
11
13
|
|
|
12
14
|
## Integração com Store
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
A implementação interage com estes estados/getters da store:
|
|
15
17
|
|
|
16
18
|
- `page/nodes` — A estrutura em árvore dos títulos
|
|
17
19
|
- `page/nodesExpanded` — Quais nós da árvore estão expandidos
|
|
@@ -37,7 +39,7 @@ O nó raiz (do DH1) mostra o título da página do i18n quando nenhum label é d
|
|
|
37
39
|
|
|
38
40
|
## Sincronização de Scroll
|
|
39
41
|
|
|
40
|
-
Quando o usuário faz scroll no conteúdo da página, o observador de scroll do `DPage` chama `useNavigator().scrolling()`, que itera sobre as âncoras registradas e seleciona a mais próxima da posição de scroll atual. Isso mantém
|
|
42
|
+
Quando o usuário faz scroll no conteúdo da página, o observador de scroll do `DPage` chama `useNavigator().scrolling()`, que itera sobre as âncoras registradas e seleciona a mais próxima da posição de scroll atual. Isso mantém o índice sincronizado com o conteúdo visível.
|
|
41
43
|
|
|
42
44
|
## Ciclo de Vida
|
|
43
45
|
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
## Overview
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Page Footer is the **bottom information area** that shows GitHub actions, translation progress, and previous/next navigation.
|
|
4
|
+
|
|
5
|
+
Under the hood, this page describes `DPageMeta`.
|
|
6
|
+
|
|
7
|
+
## Focused Pages in Basic
|
|
8
|
+
|
|
9
|
+
- [Edit on GitHub](/manual/basic/edit-on-github/overview/)
|
|
10
|
+
- [Translation Progress](/manual/basic/translation-progress/overview/)
|
|
11
|
+
- [Previous & Next](/manual/basic/previous-and-next/overview/)
|
|
4
12
|
|
|
5
13
|
## Sections
|
|
6
14
|
|
|
@@ -49,4 +57,4 @@ github: {
|
|
|
49
57
|
|
|
50
58
|
## Disabling
|
|
51
59
|
|
|
52
|
-
|
|
60
|
+
The footer is automatically excluded when `DPage` has `disableNav` prop set to `true`.
|
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
## Visão Geral
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Rodapé da Página é a **área inferior de informação** que exibe ações de GitHub, progresso de tradução e links de navegação anterior/próximo.
|
|
4
|
+
|
|
5
|
+
Na implementação, esta página descreve o `DPageMeta`.
|
|
6
|
+
|
|
7
|
+
## Páginas Focadas no Basic
|
|
8
|
+
|
|
9
|
+
- [Editar no GitHub](/manual/basic/edit-on-github/overview/)
|
|
10
|
+
- [Progresso de Tradução](/manual/basic/translation-progress/overview/)
|
|
11
|
+
- [Anterior e Próximo](/manual/basic/previous-and-next/overview/)
|
|
4
12
|
|
|
5
13
|
## Seções
|
|
6
14
|
|
|
@@ -49,4 +57,4 @@ github: {
|
|
|
49
57
|
|
|
50
58
|
## Desabilitando
|
|
51
59
|
|
|
52
|
-
|
|
60
|
+
O rodapé é automaticamente excluído quando `DPage` tem a prop `disableNav` definida como `true`.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Edit on GitHub gives readers a direct path from the current page to its Markdown source file.
|
|
4
|
+
|
|
5
|
+
This makes small documentation improvements faster, especially when the reader is already on the page that needs a change.
|
|
6
|
+
|
|
7
|
+
## What It Uses
|
|
8
|
+
|
|
9
|
+
The link is built from:
|
|
10
|
+
|
|
11
|
+
- `github.editBaseUrl` in `docsector.config.js`
|
|
12
|
+
- The current page path
|
|
13
|
+
- The current locale
|
|
14
|
+
|
|
15
|
+
## Status-Aware Labels
|
|
16
|
+
|
|
17
|
+
The button label adapts to page status:
|
|
18
|
+
|
|
19
|
+
- `done` or `new` → edit the page
|
|
20
|
+
- `draft` → complete the page
|
|
21
|
+
- `empty` → start the page
|
|
22
|
+
|
|
23
|
+
## Notes
|
|
24
|
+
|
|
25
|
+
- The target file follows the book, path, subpage, and locale naming convention.
|
|
26
|
+
- This action appears in the page footer area.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Editar no GitHub dá ao leitor um caminho direto da página atual até o arquivo Markdown de origem.
|
|
4
|
+
|
|
5
|
+
Isso acelera pequenas melhorias na documentação, especialmente quando o leitor já está na página que precisa de ajuste.
|
|
6
|
+
|
|
7
|
+
## O Que Ele Usa
|
|
8
|
+
|
|
9
|
+
O link é montado a partir de:
|
|
10
|
+
|
|
11
|
+
- `github.editBaseUrl` em `docsector.config.js`
|
|
12
|
+
- O caminho da página atual
|
|
13
|
+
- O locale atual
|
|
14
|
+
|
|
15
|
+
## Labels Sensíveis ao Status
|
|
16
|
+
|
|
17
|
+
O label do botão se adapta ao status da página:
|
|
18
|
+
|
|
19
|
+
- `done` ou `new` → editar a página
|
|
20
|
+
- `draft` → completar a página
|
|
21
|
+
- `empty` → começar a página
|
|
22
|
+
|
|
23
|
+
## Observações
|
|
24
|
+
|
|
25
|
+
- O arquivo de destino segue a convenção de nomes baseada em book, path, subpage e locale.
|
|
26
|
+
- Essa ação aparece na área de rodapé da página.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Previous & Next adds directional links to the pages that come immediately before and after the current one.
|
|
4
|
+
|
|
5
|
+
It helps readers continue through a documentation sequence without returning to the sidebar each time.
|
|
6
|
+
|
|
7
|
+
## How It Decides
|
|
8
|
+
|
|
9
|
+
- It uses the current page position in the route sequence.
|
|
10
|
+
- Only visible documentation pages are considered.
|
|
11
|
+
- Links are shown only when an adjacent page exists.
|
|
12
|
+
|
|
13
|
+
## Reader Benefit
|
|
14
|
+
|
|
15
|
+
- Faster linear reading
|
|
16
|
+
- Easier progression through tutorials and references
|
|
17
|
+
- Clearer sense of where the current page sits in the manual
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Anterior e Próximo adiciona links direcionais para as páginas imediatamente anterior e posterior à página atual.
|
|
4
|
+
|
|
5
|
+
Isso ajuda o leitor a continuar por uma sequência de documentação sem voltar à barra lateral toda vez.
|
|
6
|
+
|
|
7
|
+
## Como Ele Decide
|
|
8
|
+
|
|
9
|
+
- Usa a posição da página atual na sequência de rotas.
|
|
10
|
+
- Considera apenas páginas de documentação visíveis.
|
|
11
|
+
- Os links só aparecem quando existe uma página adjacente.
|
|
12
|
+
|
|
13
|
+
## Benefício para o Leitor
|
|
14
|
+
|
|
15
|
+
- Leitura linear mais rápida
|
|
16
|
+
- Progressão mais simples por tutoriais e referências
|
|
17
|
+
- Noção mais clara de onde a página atual está no manual
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Search helps readers find documentation pages quickly from the left sidebar.
|
|
4
|
+
|
|
5
|
+
Under the hood, this experience is powered by the menu search flow used by `DMenu`.
|
|
6
|
+
|
|
7
|
+
## What Search Looks At
|
|
8
|
+
|
|
9
|
+
- Page titles and localized labels
|
|
10
|
+
- `metadata.tags` defined in `src/pages/*.index.js`
|
|
11
|
+
- Markdown content from overview, showcase, and vs pages
|
|
12
|
+
|
|
13
|
+
## Behavior
|
|
14
|
+
|
|
15
|
+
- Search starts when the query has more than one character.
|
|
16
|
+
- Results follow the active documentation version and current book.
|
|
17
|
+
- The current locale is preferred, with `en-US` as fallback when needed.
|
|
18
|
+
- Input is debounced so fast typing does not rebuild results on every keystroke.
|
|
19
|
+
|
|
20
|
+
## Good Practices
|
|
21
|
+
|
|
22
|
+
- Keep page titles descriptive.
|
|
23
|
+
- Add useful search tags close to the page entry in the registry.
|
|
24
|
+
- Prefer short, concrete wording so readers can guess the right term easily.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Busca ajuda o leitor a encontrar páginas da documentação rapidamente pela barra lateral esquerda.
|
|
4
|
+
|
|
5
|
+
Na implementação, essa experiência é sustentada pelo fluxo de busca usado em `DMenu`.
|
|
6
|
+
|
|
7
|
+
## O Que a Busca Considera
|
|
8
|
+
|
|
9
|
+
- Títulos de página e labels localizados
|
|
10
|
+
- `metadata.tags` definidos em `src/pages/*.index.js`
|
|
11
|
+
- Conteúdo Markdown das páginas overview, showcase e vs
|
|
12
|
+
|
|
13
|
+
## Comportamento
|
|
14
|
+
|
|
15
|
+
- A busca começa quando a consulta tem mais de um caractere.
|
|
16
|
+
- Os resultados seguem a versão ativa da documentação e o book atual.
|
|
17
|
+
- O locale atual tem prioridade, com fallback para `en-US` quando necessário.
|
|
18
|
+
- O input usa debounce para que a digitação rápida não reconstrua os resultados a cada tecla.
|
|
19
|
+
|
|
20
|
+
## Boas Práticas
|
|
21
|
+
|
|
22
|
+
- Mantenha títulos de página descritivos.
|
|
23
|
+
- Adicione tags de busca úteis perto da entrada da página no registry.
|
|
24
|
+
- Prefira termos curtos e concretos para o leitor adivinhar a palavra certa com facilidade.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Translation Progress shows how complete the current locale is and how many translations are available for the page.
|
|
4
|
+
|
|
5
|
+
It helps readers and maintainers understand whether a page is fully localized or still in progress.
|
|
6
|
+
|
|
7
|
+
## Visible Signals
|
|
8
|
+
|
|
9
|
+
- A progress chip for the active locale
|
|
10
|
+
- A chip showing how many locales are available compared to the configured total
|
|
11
|
+
|
|
12
|
+
## Data Source
|
|
13
|
+
|
|
14
|
+
The progress view relies on translation metadata such as `_sections.done` and `_sections.count`.
|
|
15
|
+
|
|
16
|
+
## Notes
|
|
17
|
+
|
|
18
|
+
- This information appears in the page footer area.
|
|
19
|
+
- Translation progress is more useful when section metadata is kept accurate.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Progresso de Tradução mostra o quanto o locale atual está completo e quantas traduções estão disponíveis para a página.
|
|
4
|
+
|
|
5
|
+
Isso ajuda leitores e mantenedores a entender se uma página está totalmente localizada ou ainda em andamento.
|
|
6
|
+
|
|
7
|
+
## Sinais Visíveis
|
|
8
|
+
|
|
9
|
+
- Um chip de progresso para o locale ativo
|
|
10
|
+
- Um chip mostrando quantos locales estão disponíveis em relação ao total configurado
|
|
11
|
+
|
|
12
|
+
## Fonte dos Dados
|
|
13
|
+
|
|
14
|
+
A visualização de progresso depende de metadados de tradução como `_sections.done` e `_sections.count`.
|
|
15
|
+
|
|
16
|
+
## Observações
|
|
17
|
+
|
|
18
|
+
- Essa informação aparece na área de rodapé da página.
|
|
19
|
+
- O progresso de tradução fica mais útil quando os metadados de seções são mantidos corretos.
|