@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.
Files changed (134) hide show
  1. package/README.md +13 -2
  2. package/bin/docsector.js +1 -1
  3. package/package.json +10 -7
  4. package/src/components/DH2.vue +1 -1
  5. package/src/components/DH3.vue +1 -1
  6. package/src/components/DH4.vue +1 -1
  7. package/src/components/DH5.vue +1 -1
  8. package/src/components/DH6.vue +1 -1
  9. package/src/components/DMenu.vue +1 -1
  10. package/src/components/DPage.vue +26 -6
  11. package/src/components/DPageAnchor.vue +3 -9
  12. package/src/components/DPageMeta.vue +1 -0
  13. package/src/components/DPageTokens.vue +5 -5
  14. package/src/components/page-section-tokens.js +59 -6
  15. package/src/composables/useNavigator.js +45 -15
  16. package/src/css/app.sass +12 -0
  17. package/src/pages/404Page.vue +2 -2
  18. package/src/pages/Homepage.en-US.md +3 -3
  19. package/src/pages/Homepage.pt-BR.md +3 -3
  20. package/src/pages/guide/i18n-and-markdown.overview.en-US.md +26 -4
  21. package/src/pages/guide/i18n-and-markdown.overview.pt-BR.md +23 -1
  22. package/src/pages/guide/pages-and-routing.overview.en-US.md +11 -9
  23. package/src/pages/guide/pages-and-routing.overview.pt-BR.md +11 -9
  24. package/src/pages/guide.index.js +0 -28
  25. package/src/pages/manual/basic/branding.overview.en-US.md +27 -0
  26. package/src/pages/manual/basic/branding.overview.pt-BR.md +27 -0
  27. package/src/pages/manual/{components → basic}/d-menu.overview.en-US.md +11 -3
  28. package/src/pages/manual/{components → basic}/d-menu.overview.pt-BR.md +11 -3
  29. package/src/pages/manual/{components → basic}/d-page-anchor.overview.en-US.md +5 -3
  30. package/src/pages/manual/{components → basic}/d-page-anchor.overview.pt-BR.md +5 -3
  31. package/src/pages/manual/{components → basic}/d-page-meta.overview.en-US.md +10 -2
  32. package/src/pages/manual/{components → basic}/d-page-meta.overview.pt-BR.md +10 -2
  33. package/src/pages/manual/basic/edit-on-github.overview.en-US.md +26 -0
  34. package/src/pages/manual/basic/edit-on-github.overview.pt-BR.md +26 -0
  35. package/src/pages/manual/basic/previous-and-next.overview.en-US.md +17 -0
  36. package/src/pages/manual/basic/previous-and-next.overview.pt-BR.md +17 -0
  37. package/src/pages/manual/basic/search.overview.en-US.md +24 -0
  38. package/src/pages/manual/basic/search.overview.pt-BR.md +24 -0
  39. package/src/pages/manual/basic/translation-progress.overview.en-US.md +19 -0
  40. package/src/pages/manual/basic/translation-progress.overview.pt-BR.md +19 -0
  41. package/src/pages/manual/basic/version-switcher.overview.en-US.md +28 -0
  42. package/src/pages/manual/basic/version-switcher.overview.pt-BR.md +28 -0
  43. package/src/pages/manual/components/d-subpage.overview.en-US.md +2 -2
  44. package/src/pages/manual/components/d-subpage.overview.pt-BR.md +2 -2
  45. package/src/pages/manual/content/blocks/code-blocks.overview.en-US.md +55 -0
  46. package/src/pages/manual/content/blocks/code-blocks.overview.pt-BR.md +55 -0
  47. package/src/pages/manual/{components/d-page-source-code.showcase.en-US.md → content/blocks/code-blocks.showcase.en-US.md} +14 -12
  48. package/src/pages/manual/{components/d-page-source-code.showcase.pt-BR.md → content/blocks/code-blocks.showcase.pt-BR.md} +28 -26
  49. package/src/pages/manual/{components/d-page-expandable.overview.en-US.md → content/blocks/expandable.overview.en-US.md} +3 -12
  50. package/src/pages/manual/{components/d-page-expandable.overview.pt-BR.md → content/blocks/expandable.overview.pt-BR.md} +3 -12
  51. package/src/pages/manual/content/blocks/headings.overview.en-US.md +45 -0
  52. package/src/pages/manual/content/blocks/headings.overview.pt-BR.md +45 -0
  53. package/src/pages/manual/{components/d-headings.showcase.en-US.md → content/blocks/headings.showcase.en-US.md} +1 -1
  54. package/src/pages/manual/{components/d-headings.showcase.pt-BR.md → content/blocks/headings.showcase.pt-BR.md} +1 -1
  55. package/src/pages/manual/content/blocks/hints.overview.en-US.md +30 -0
  56. package/src/pages/manual/content/blocks/hints.overview.pt-BR.md +30 -0
  57. package/src/pages/manual/content/blocks/hints.showcase.en-US.md +30 -0
  58. package/src/pages/manual/content/blocks/hints.showcase.pt-BR.md +30 -0
  59. package/src/pages/manual/content/blocks/images.overview.en-US.md +16 -0
  60. package/src/pages/manual/content/blocks/images.overview.pt-BR.md +16 -0
  61. package/src/pages/manual/content/blocks/images.showcase.en-US.md +11 -0
  62. package/src/pages/manual/content/blocks/images.showcase.pt-BR.md +11 -0
  63. package/src/pages/manual/content/blocks/math-and-tex.overview.en-US.md +27 -0
  64. package/src/pages/manual/content/blocks/math-and-tex.overview.pt-BR.md +27 -0
  65. package/src/pages/manual/content/blocks/math-and-tex.showcase.en-US.md +14 -0
  66. package/src/pages/manual/content/blocks/math-and-tex.showcase.pt-BR.md +14 -0
  67. package/src/pages/manual/content/blocks/mermaid-diagrams.overview.en-US.md +22 -0
  68. package/src/pages/manual/content/blocks/mermaid-diagrams.overview.pt-BR.md +22 -0
  69. package/src/pages/manual/content/blocks/ordered-lists.overview.en-US.md +19 -0
  70. package/src/pages/manual/content/blocks/ordered-lists.overview.pt-BR.md +19 -0
  71. package/src/pages/manual/content/blocks/ordered-lists.showcase.en-US.md +21 -0
  72. package/src/pages/manual/content/blocks/ordered-lists.showcase.pt-BR.md +21 -0
  73. package/src/pages/manual/content/blocks/paragraphs.overview.en-US.md +19 -0
  74. package/src/pages/manual/content/blocks/paragraphs.overview.pt-BR.md +19 -0
  75. package/src/pages/manual/content/blocks/paragraphs.showcase.en-US.md +9 -0
  76. package/src/pages/manual/content/blocks/paragraphs.showcase.pt-BR.md +9 -0
  77. package/src/pages/manual/content/blocks/quick-links.overview.en-US.md +28 -0
  78. package/src/pages/manual/content/blocks/quick-links.overview.pt-BR.md +28 -0
  79. package/src/pages/manual/content/blocks/quick-links.showcase.en-US.md +34 -0
  80. package/src/pages/manual/content/blocks/quick-links.showcase.pt-BR.md +34 -0
  81. package/src/pages/manual/content/blocks/quotes.overview.en-US.md +24 -0
  82. package/src/pages/manual/content/blocks/quotes.overview.pt-BR.md +24 -0
  83. package/src/pages/manual/content/blocks/quotes.showcase.en-US.md +17 -0
  84. package/src/pages/manual/content/blocks/quotes.showcase.pt-BR.md +17 -0
  85. package/src/pages/manual/content/blocks/raw-html.overview.en-US.md +19 -0
  86. package/src/pages/manual/content/blocks/raw-html.overview.pt-BR.md +19 -0
  87. package/src/pages/manual/content/blocks/raw-html.showcase.en-US.md +12 -0
  88. package/src/pages/manual/content/blocks/raw-html.showcase.pt-BR.md +12 -0
  89. package/src/pages/manual/content/blocks/tables.overview.en-US.md +19 -0
  90. package/src/pages/manual/content/blocks/tables.overview.pt-BR.md +19 -0
  91. package/src/pages/manual/content/blocks/tables.showcase.en-US.md +17 -0
  92. package/src/pages/manual/content/blocks/tables.showcase.pt-BR.md +17 -0
  93. package/src/pages/manual/content/blocks/unordered-lists.overview.en-US.md +21 -0
  94. package/src/pages/manual/content/blocks/unordered-lists.overview.pt-BR.md +21 -0
  95. package/src/pages/manual/content/blocks/unordered-lists.showcase.en-US.md +24 -0
  96. package/src/pages/manual/content/blocks/unordered-lists.showcase.pt-BR.md +24 -0
  97. package/src/pages/manual/content/structures/books.overview.en-US.md +36 -0
  98. package/src/pages/manual/content/structures/books.overview.pt-BR.md +36 -0
  99. package/src/pages/manual/content/structures/page.overview.en-US.md +61 -0
  100. package/src/pages/manual/content/structures/page.overview.pt-BR.md +61 -0
  101. package/src/pages/manual/content/structures/subpage.overview.en-US.md +62 -0
  102. package/src/pages/manual/content/structures/subpage.overview.pt-BR.md +62 -0
  103. package/src/pages/manual.index.js +487 -153
  104. package/src/router/routes.js +1 -1
  105. package/src/pages/guide/alerts-and-blockquotes.overview.en-US.md +0 -65
  106. package/src/pages/guide/alerts-and-blockquotes.overview.pt-BR.md +0 -65
  107. package/src/pages/manual/components/d-headings.overview.en-US.md +0 -54
  108. package/src/pages/manual/components/d-headings.overview.pt-BR.md +0 -54
  109. package/src/pages/manual/components/d-mermaid-diagram.overview.en-US.md +0 -31
  110. package/src/pages/manual/components/d-mermaid-diagram.overview.pt-BR.md +0 -29
  111. package/src/pages/manual/components/d-page-blockquote.overview.en-US.md +0 -66
  112. package/src/pages/manual/components/d-page-blockquote.overview.pt-BR.md +0 -66
  113. package/src/pages/manual/components/d-page-blockquote.showcase.en-US.md +0 -34
  114. package/src/pages/manual/components/d-page-blockquote.showcase.pt-BR.md +0 -34
  115. package/src/pages/manual/components/d-page-section.overview.en-US.md +0 -57
  116. package/src/pages/manual/components/d-page-section.overview.pt-BR.md +0 -57
  117. package/src/pages/manual/components/d-page-section.showcase.en-US.md +0 -43
  118. package/src/pages/manual/components/d-page-section.showcase.pt-BR.md +0 -43
  119. package/src/pages/manual/components/d-page-source-code.overview.en-US.md +0 -68
  120. package/src/pages/manual/components/d-page-source-code.overview.pt-BR.md +0 -68
  121. package/src/pages/manual/components/d-page.overview.en-US.md +0 -59
  122. package/src/pages/manual/components/d-page.overview.pt-BR.md +0 -59
  123. package/src/pages/manual/components/d-page.showcase.en-US.md +0 -35
  124. package/src/pages/manual/components/d-page.showcase.pt-BR.md +0 -35
  125. package/src/pages/manual/components/q-zoom.overview.en-US.md +0 -71
  126. package/src/pages/manual/components/q-zoom.overview.pt-BR.md +0 -71
  127. package/src/pages/manual/composables/use-navigator.overview.en-US.md +0 -89
  128. package/src/pages/manual/composables/use-navigator.overview.pt-BR.md +0 -89
  129. package/src/pages/manual/store/modules.overview.en-US.md +0 -96
  130. package/src/pages/manual/store/modules.overview.pt-BR.md +0 -96
  131. /package/src/pages/manual/{components/d-page-expandable.showcase.en-US.md → content/blocks/expandable.showcase.en-US.md} +0 -0
  132. /package/src/pages/manual/{components/d-page-expandable.showcase.pt-BR.md → content/blocks/expandable.showcase.pt-BR.md} +0 -0
  133. /package/src/pages/manual/{components/d-mermaid-diagram.showcase.en-US.md → content/blocks/mermaid-diagrams.showcase.en-US.md} +0 -0
  134. /package/src/pages/manual/{components/d-mermaid-diagram.showcase.pt-BR.md → content/blocks/mermaid-diagrams.showcase.pt-BR.md} +0 -0
@@ -0,0 +1,28 @@
1
+ ## Overview
2
+
3
+ Version Switcher lets readers move between the current documentation and archived or alternative versions.
4
+
5
+ It helps keep long-lived docs usable when the project supports more than one release line.
6
+
7
+ ## How It Works
8
+
9
+ - The selector reads the configured versions list.
10
+ - Current docs usually stay on unprefixed routes.
11
+ - Archived versions can use a route prefix such as `/v0.x`.
12
+ - When possible, the switcher tries to open the equivalent page in the target version.
13
+ - If the same page does not exist there, it falls back to the first matching route in that book.
14
+
15
+ ## Release Badges
16
+
17
+ The selector can show badges such as:
18
+
19
+ - `released`
20
+ - `draft`
21
+ - `deprecated`
22
+
23
+ Custom badge labels and colors can also be configured per version.
24
+
25
+ ## Notes
26
+
27
+ - A version entry may also point to an external URL.
28
+ - Keep labels short so the dropdown stays easy to scan.
@@ -0,0 +1,28 @@
1
+ ## Visão Geral
2
+
3
+ Seletor de Versão permite que o leitor navegue entre a documentação atual e versões arquivadas ou alternativas.
4
+
5
+ Ele ajuda a manter docs de longa duração utilizáveis quando o projeto suporta mais de uma linha de release.
6
+
7
+ ## Como Funciona
8
+
9
+ - O seletor lê a lista de versões configuradas.
10
+ - A documentação atual normalmente fica em rotas sem prefixo.
11
+ - Versões arquivadas podem usar um prefixo como `/v0.x`.
12
+ - Quando possível, o seletor tenta abrir a página equivalente na versão de destino.
13
+ - Se a mesma página não existir lá, ele faz fallback para a primeira rota compatível naquele book.
14
+
15
+ ## Badges de Release
16
+
17
+ O seletor pode mostrar badges como:
18
+
19
+ - `released`
20
+ - `draft`
21
+ - `deprecated`
22
+
23
+ Também é possível configurar labels e cores customizadas por versão.
24
+
25
+ ## Observações
26
+
27
+ - Uma entrada de versão também pode apontar para uma URL externa.
28
+ - Mantenha os labels curtos para o dropdown continuar fácil de escanear.
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## How It Works
6
6
 
7
- DSubpage generates a deterministic numeric ID from the current route path using a hash function. This ID is passed to `DPageSection` to ensure unique component keys across page navigations.
7
+ DSubpage generates a deterministic numeric ID from the current route path using a hash function. This ID is passed to `DPageSection` to keep per-page renderer indexes stable across page navigations.
8
8
 
9
9
  ## Template
10
10
 
@@ -34,7 +34,7 @@ const id = computed(() => {
34
34
  })
35
35
  ```
36
36
 
37
- This ensures that each page generates a unique set of anchor IDs, preventing collisions when switching between pages.
37
+ This keeps per-page renderer state isolated when switching between pages. Markdown section headings themselves use GitHub-compatible slugs derived from the heading text, so README-style Table of Contents links keep working.
38
38
 
39
39
  ## When to Use
40
40
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Como Funciona
6
6
 
7
- DSubpage gera um ID numérico determinístico a partir do caminho da rota atual usando uma função hash. Esse ID é passado ao `DPageSection` para garantir chaves de componente únicas entre navegações de página.
7
+ DSubpage gera um ID numérico determinístico a partir do caminho da rota atual usando uma função hash. Esse ID é passado ao `DPageSection` para manter estáveis os índices internos do renderer em cada página.
8
8
 
9
9
  ## Template
10
10
 
@@ -34,7 +34,7 @@ const id = computed(() => {
34
34
  })
35
35
  ```
36
36
 
37
- Isso garante que cada página gere um conjunto único de IDs de âncora, prevenindo colisões ao navegar entre páginas.
37
+ Isso mantém o estado interno do renderer isolado ao navegar entre páginas. Os headings Markdown em si usam slugs compatíveis com GitHub derivados do texto do título, então links de Table of Contents no estilo README continuam funcionando.
38
38
 
39
39
  ## Quando Usar
40
40
 
@@ -0,0 +1,55 @@
1
+ ## Overview
2
+
3
+ Code blocks are authored with standard fenced Markdown and rendered with syntax highlighting, line numbers, copy-to-clipboard, and optional metadata such as filenames, tabs, and breadcrumbs.
4
+
5
+ Docsector uses Prism.js for highlighting and automatically adapts the visual style to light and dark themes.
6
+
7
+ ## Basic Syntax
8
+
9
+ ````markdown
10
+ ```bash
11
+ npm install
12
+ npm run dev
13
+ ```
14
+ ````
15
+
16
+ ## Supported Languages
17
+
18
+ The built-in documentation currently ships with support for:
19
+
20
+ - `php`
21
+ - `bash`
22
+ - `html`
23
+ - `javascript`
24
+
25
+ Additional Prism languages can be added when the project needs them.
26
+
27
+ ## Useful Attributes
28
+
29
+ Code fences support extra metadata with `:attr;` syntax:
30
+
31
+ | Attribute | Purpose |
32
+ |-----------|---------|
33
+ | `filename` | Shows a filename in the metadata bar |
34
+ | `group` | Joins consecutive blocks into tabs |
35
+ | `tab` | Sets the visible tab label |
36
+ | `breadcrumb` | Shows a path-like breadcrumb above the active block |
37
+
38
+ ## What Readers Get
39
+
40
+ - Language-aware syntax highlighting
41
+ - Line numbers on multi-line snippets
42
+ - Copy button in the metadata bar
43
+ - Tabs for grouped examples
44
+ - Breadcrumbs and file icons when metadata is provided
45
+
46
+ ## Example With Tabs
47
+
48
+ ````markdown
49
+ ```php :group="example"; :tab="example.php"; :breadcrumb="src > example.php";
50
+ echo "Hello";
51
+ ```
52
+ ```bash :group="example"; :tab="example.sh"; :breadcrumb="scripts > example.sh";
53
+ echo "Hello"
54
+ ```
55
+ ````
@@ -0,0 +1,55 @@
1
+ ## Visão Geral
2
+
3
+ Blocos de código são escritos com cercas Markdown padrão e renderizados com syntax highlighting, números de linha, botão de cópia e metadados opcionais como nome de arquivo, abas e breadcrumbs.
4
+
5
+ O Docsector usa Prism.js para o highlighting e adapta automaticamente o visual aos modos claro e escuro.
6
+
7
+ ## Sintaxe Básica
8
+
9
+ ````markdown
10
+ ```bash
11
+ npm install
12
+ npm run dev
13
+ ```
14
+ ````
15
+
16
+ ## Linguagens Suportadas
17
+
18
+ A documentação padrão do projeto já vem com suporte para:
19
+
20
+ - `php`
21
+ - `bash`
22
+ - `html`
23
+ - `javascript`
24
+
25
+ Outras linguagens podem ser adicionadas quando o projeto precisar.
26
+
27
+ ## Atributos Úteis
28
+
29
+ As fences de código aceitam metadados extras com a sintaxe `:attr;`:
30
+
31
+ | Atributo | Finalidade |
32
+ |----------|------------|
33
+ | `filename` | Mostra um nome de arquivo na barra de metadados |
34
+ | `group` | Junta blocos consecutivos em abas |
35
+ | `tab` | Define o rótulo visível da aba |
36
+ | `breadcrumb` | Mostra um caminho acima do bloco ativo |
37
+
38
+ ## O Que o Leitor Recebe
39
+
40
+ - Syntax highlighting por linguagem
41
+ - Números de linha em snippets com várias linhas
42
+ - Botão de cópia na barra de metadados
43
+ - Abas para exemplos agrupados
44
+ - Breadcrumbs e ícones de arquivo quando há metadados
45
+
46
+ ## Exemplo com Abas
47
+
48
+ ````markdown
49
+ ```php :group="example"; :tab="example.php"; :breadcrumb="src > example.php";
50
+ echo "Hello";
51
+ ```
52
+ ```bash :group="example"; :tab="example.sh"; :breadcrumb="scripts > example.sh";
53
+ echo "Hello"
54
+ ```
55
+ ````
@@ -1,6 +1,6 @@
1
1
  ## Showcase
2
2
 
3
- Here are code blocks in different languages demonstrating the DPageSourceCode component:
3
+ Here are code blocks in different languages showing how Docsector renders technical examples:
4
4
 
5
5
  ### PHP Example
6
6
 
@@ -90,17 +90,19 @@ return [
90
90
  '/deployment' => 'DeploymentPage',
91
91
  '/plugins' => 'PluginsPage',
92
92
  '/theming' => 'ThemingPage',
93
- '/components' => 'ComponentsPage',
94
- '/components/d-page' => 'DPageOverview',
95
- '/components/d-page-section' => 'DPageSectionOverview',
96
- '/components/d-page-source-code' => 'DPageSourceCodeOverview',
97
- '/components/d-menu' => 'DMenuOverview',
98
- '/components/d-headings' => 'DHeadingsOverview',
99
- '/components/d-mermaid-diagram' => 'DMermaidDiagramOverview',
100
- '/components/d-page-blockquote' => 'DPageBlockquoteOverview',
101
- '/components/d-quick-links' => 'DQuickLinksOverview',
102
- '/manual' => 'ManualIndex',
103
- '/manual/showcase' => 'ManualShowcase',
93
+ '/basic' => 'BasicPage',
94
+ '/basic/d-menu' => 'NavigationMenuOverview',
95
+ '/basic/d-page-anchor' => 'TableOfContentsOverview',
96
+ '/basic/d-page-meta' => 'PageFooterOverview',
97
+ '/content/structures/page' => 'PageOverview',
98
+ '/content/blocks' => 'BlocksSection',
99
+ '/content/blocks/paragraphs' => 'ParagraphsOverview',
100
+ '/content/blocks/headings' => 'HeadingsOverview',
101
+ '/content/blocks/code-blocks' => 'CodeBlocksOverview',
102
+ '/content/blocks/mermaid-diagrams' => 'MermaidDiagramsOverview',
103
+ '/content/blocks/quotes' => 'QuoteOverview',
104
+ '/content/blocks/expandable' => 'ExpandableOverview',
105
+ '/content/blocks/quick-links' => 'QuickLinksOverview',
104
106
  '/guide' => 'GuideIndex',
105
107
  '/guide/markdown' => 'MarkdownGuide',
106
108
  '/guide/i18n' => 'I18nGuide',
@@ -1,6 +1,6 @@
1
1
  ## Demonstração
2
2
 
3
- Aqui estão blocos de código em diferentes linguagens demonstrando o componente DPageSourceCode:
3
+ Aqui estão blocos de código em diferentes linguagens mostrando como o Docsector renderiza exemplos técnicos:
4
4
 
5
5
  ### Exemplo PHP
6
6
 
@@ -84,32 +84,34 @@ console.log('Exemplo de breadcrumb gigante')
84
84
 
85
85
  ```php :group="exemplo-longo"; :tab="rotas.php"; :breadcrumb="src > rotas > rotas.php";
86
86
  return [
87
- '/visao-geral' => 'PaginaVisaoGeral',
88
- '/primeiros-passos' => 'PaginaPrimeirosPassos',
89
- '/configuracao' => 'PaginaConfiguracao',
90
- '/deploy' => 'PaginaDeploy',
87
+ '/overview' => 'PaginaVisaoGeral',
88
+ '/getting-started' => 'PaginaPrimeirosPassos',
89
+ '/configuration' => 'PaginaConfiguracao',
90
+ '/deployment' => 'PaginaDeploy',
91
91
  '/plugins' => 'PaginaPlugins',
92
- '/temas' => 'PaginaTemas',
93
- '/componentes' => 'PaginaComponentes',
94
- '/componentes/d-page' => 'DPageVisaoGeral',
95
- '/componentes/d-page-section' => 'DPageSectionVisaoGeral',
96
- '/componentes/d-page-source-code' => 'DPageSourceCodeVisaoGeral',
97
- '/componentes/d-menu' => 'DMenuVisaoGeral',
98
- '/componentes/d-headings' => 'DHeadingsVisaoGeral',
99
- '/componentes/d-mermaid-diagram' => 'DMermaidDiagramVisaoGeral',
100
- '/componentes/d-page-blockquote' => 'DPageBlockquoteVisaoGeral',
101
- '/componentes/d-quick-links' => 'DQuickLinksVisaoGeral',
102
- '/manual' => 'IndiceManual',
103
- '/manual/demonstracao' => 'DemonstracaoManual',
104
- '/guia' => 'IndiceGuia',
105
- '/guia/markdown' => 'GuiaMarkdown',
106
- '/guia/i18n' => 'GuiaI18n',
107
- '/guia/rotas' => 'GuiaRotas',
108
- '/guia/busca' => 'GuiaBusca',
109
- '/guia/api' => 'GuiaApi',
110
- '/guia/mcp' => 'GuiaMcp',
111
- '/guia/releases' => 'GuiaReleases',
112
- '/guia/changelog' => 'GuiaChangelog',
92
+ '/theming' => 'PaginaTemas',
93
+ '/basic' => 'PaginaBasico',
94
+ '/basic/d-menu' => 'MenuDeNavegacaoVisaoGeral',
95
+ '/basic/d-page-anchor' => 'IndiceDaPaginaVisaoGeral',
96
+ '/basic/d-page-meta' => 'RodapeDaPaginaVisaoGeral',
97
+ '/content/structures/page' => 'PaginaVisaoGeral',
98
+ '/content/blocks' => 'SecaoBlocos',
99
+ '/content/blocks/paragraphs' => 'ParagrafosVisaoGeral',
100
+ '/content/blocks/headings' => 'TitulosVisaoGeral',
101
+ '/content/blocks/code-blocks' => 'BlocosDeCodigoVisaoGeral',
102
+ '/content/blocks/mermaid-diagrams' => 'DiagramasMermaidVisaoGeral',
103
+ '/content/blocks/quotes' => 'CitacaoVisaoGeral',
104
+ '/content/blocks/expandable' => 'ExpansivelVisaoGeral',
105
+ '/content/blocks/quick-links' => 'QuickLinksVisaoGeral',
106
+ '/guide' => 'IndiceGuia',
107
+ '/guide/markdown' => 'GuiaMarkdown',
108
+ '/guide/i18n' => 'GuiaI18n',
109
+ '/guide/routing' => 'GuiaRotas',
110
+ '/guide/search' => 'GuiaBusca',
111
+ '/guide/api' => 'GuiaApi',
112
+ '/guide/mcp' => 'GuiaMcp',
113
+ '/guide/releases' => 'GuiaReleases',
114
+ '/guide/changelog' => 'GuiaChangelog',
113
115
  ];
114
116
  ```
115
117
  ```bash :group="exemplo-longo"; :tab="deploy.sh"; :breadcrumb="scripts > deploy.sh";
@@ -1,19 +1,10 @@
1
1
  ## Overview
2
2
 
3
- `DPageExpandable` renders a collapsible content section backed by the Markdown custom element `<d-expandable>`.
3
+ Expandable blocks collapse secondary content behind a clickable title.
4
4
 
5
- It is designed for secondary content that should stay available without stretching the main reading flow. The body keeps the same rich Markdown features already available in page sections, including lists, blockquotes, code blocks, Mermaid diagrams, tables, raw HTML, and quick links.
5
+ They are a good fit when the main section should stay short, but readers may still need optional details, checklists, appendix material, or longer examples.
6
6
 
7
- ## Props
8
-
9
- | Prop | Type | Default | Description |
10
- |------|------|---------|-------------|
11
- | `title` | `String` | `''` | Header label shown in the expandable trigger |
12
- | `open` | `Boolean` | `false` | Initial expanded state |
13
-
14
- ## Slot
15
-
16
- The default slot receives the parsed content body.
7
+ The block is authored with the custom Markdown element `<d-expandable>`.
17
8
 
18
9
  ## HTML Example
19
10
 
@@ -1,19 +1,10 @@
1
1
  ## Visão Geral
2
2
 
3
- `DPageExpandable` renderiza uma seção recolhível baseada no elemento customizado de Markdown `<d-expandable>`.
3
+ Blocos expansíveis recolhem conteúdo secundário atrás de um título clicável.
4
4
 
5
- Ele foi criado para conteúdo secundário que deve continuar disponível sem alongar o fluxo principal de leitura. O corpo mantém os mesmos recursos ricos de Markdown já usados nas seções da página, incluindo listas, blockquotes, blocos de código, diagramas Mermaid, tabelas, HTML bruto e quick links.
5
+ Eles funcionam bem quando a seção principal precisa continuar curta, mas o leitor ainda pode precisar de detalhes opcionais, checklists, apêndices ou exemplos mais longos.
6
6
 
7
- ## Props
8
-
9
- | Prop | Tipo | Padrão | Descrição |
10
- |------|------|--------|-----------|
11
- | `title` | `String` | `''` | Rótulo do cabeçalho exibido no gatilho do expansível |
12
- | `open` | `Boolean` | `false` | Estado inicial expandido |
13
-
14
- ## Slot
15
-
16
- O slot padrão recebe o corpo de conteúdo já parseado.
7
+ O bloco é escrito com o custom element Markdown `<d-expandable>`.
17
8
 
18
9
  ## Exemplo em HTML
19
10
 
@@ -0,0 +1,45 @@
1
+ ## Overview
2
+
3
+ Headings organize the reading flow and power the right-side table of contents.
4
+
5
+ In Docsector, each body heading becomes a navigable anchor automatically using a GitHub-compatible slug, so readers can jump through the page while the URL hash and ToC stay in sync.
6
+
7
+ ## Markdown Levels
8
+
9
+ | Markdown | HTML | Typical use |
10
+ |----------|------|-------------|
11
+ | `#` | `<h1>` | Page title generated from the page metadata |
12
+ | `##` | `<h2>` | Main sections |
13
+ | `###` | `<h3>` | Sub-sections |
14
+ | `####` | `<h4>` | Detail sections |
15
+ | `#####` | `<h5>` | Minor sections |
16
+ | `######` | `<h6>` | Very small subdivisions |
17
+
18
+ ## Authoring Notes
19
+
20
+ - In page content, the first heading you usually write is `##`, because the page title is already handled for you.
21
+ - Keep heading levels in order whenever possible. Skipping levels makes the ToC harder to scan.
22
+ - Use headings to break long pages into chunks that can be bookmarked, linked, and referenced from a standard Markdown Table of Contents.
23
+
24
+ ## What Docsector Handles
25
+
26
+ - Registers headings as anchors in the page ToC
27
+ - Uses GitHub-compatible slugs for heading hashes
28
+ - Keeps navigation hashes aligned with the selected heading
29
+ - Builds the section tree automatically from the Markdown structure
30
+
31
+ ## Markdown Example
32
+
33
+ ```markdown
34
+ ## Installation
35
+
36
+ Short introduction.
37
+
38
+ ### Environment variables
39
+
40
+ Extra setup details.
41
+
42
+ #### Optional flags
43
+
44
+ Notes for advanced readers.
45
+ ```
@@ -0,0 +1,45 @@
1
+ ## Visão Geral
2
+
3
+ Títulos organizam o fluxo da leitura e alimentam o índice lateral da página.
4
+
5
+ No Docsector, cada heading escrito no corpo do Markdown vira uma âncora navegável automaticamente usando slug compatível com GitHub, mantendo hash da URL e ToC sincronizados.
6
+
7
+ ## Níveis de Markdown
8
+
9
+ | Markdown | HTML | Uso típico |
10
+ |----------|------|------------|
11
+ | `#` | `<h1>` | Título da página gerado a partir dos metadados |
12
+ | `##` | `<h2>` | Seções principais |
13
+ | `###` | `<h3>` | Sub-seções |
14
+ | `####` | `<h4>` | Seções de detalhe |
15
+ | `#####` | `<h5>` | Divisões menores |
16
+ | `######` | `<h6>` | Divisões bem pequenas |
17
+
18
+ ## Notas de Autoria
19
+
20
+ - No conteúdo da página, o primeiro heading costuma ser `##`, porque o título principal já é resolvido automaticamente.
21
+ - Sempre que possível, mantenha a hierarquia em ordem. Pular níveis deixa o ToC mais difícil de ler.
22
+ - Use títulos para quebrar páginas longas em partes que possam ser linkadas, revisitadas e referenciadas por um Table of Contents padrão de Markdown.
23
+
24
+ ## O Que o Docsector Faz
25
+
26
+ - Registra os headings como âncoras no ToC da página
27
+ - Usa slugs compatíveis com GitHub nos hashes dos headings
28
+ - Mantém os hashes de navegação alinhados ao heading selecionado
29
+ - Monta a árvore de seções automaticamente a partir da estrutura do Markdown
30
+
31
+ ## Exemplo em Markdown
32
+
33
+ ```markdown
34
+ ## Instalação
35
+
36
+ Introdução curta.
37
+
38
+ ### Variáveis de ambiente
39
+
40
+ Detalhes extras de setup.
41
+
42
+ #### Flags opcionais
43
+
44
+ Notas para leitores avançados.
45
+ ```
@@ -29,4 +29,4 @@ More content...
29
29
  Even more content...
30
30
  ```
31
31
 
32
- DPageSection automatically maps each heading level to the corresponding DH component.
32
+ Docsector automatically maps each heading level to the right semantic heading and a matching ToC entry.
@@ -29,4 +29,4 @@ Mais conteúdo...
29
29
  Ainda mais conteúdo...
30
30
  ```
31
31
 
32
- DPageSection automaticamente mapeia cada nível de heading ao componente DH correspondente.
32
+ O Docsector mapeia cada nível de heading para a marcação semântica correta e para a entrada correspondente no ToC.
@@ -0,0 +1,30 @@
1
+ ## Overview
2
+
3
+ Hints are GitHub-style alert blocks rendered from Markdown blockquotes with a `[!TYPE]` marker.
4
+
5
+ Use them when the content should be read as a note, tip, warning, or other semantic callout.
6
+
7
+ For neutral quoted text without alert styling, see [Quote](/manual/content/blocks/quotes/overview/).
8
+
9
+ ## Markdown Syntax
10
+
11
+ ```markdown
12
+ > [!WARNING]
13
+ > This operation may interrupt workers.
14
+ ```
15
+
16
+ ## Supported Markers
17
+
18
+ | Marker | When to use |
19
+ |--------|-------------|
20
+ | `NOTE` | Extra context or background |
21
+ | `TIP` | Practical advice or best practice |
22
+ | `IMPORTANT` | Critical information that must be noticed |
23
+ | `WARNING` | Pitfalls, risky actions, or breaking changes |
24
+ | `CAUTION` | High-risk actions that deserve extra care |
25
+
26
+ ## Notes
27
+
28
+ - The marker should appear on the first line of the blockquote.
29
+ - Hint bodies can still contain paragraphs, lists, code blocks, and math.
30
+ - Unknown markers fall back to a regular quote.
@@ -0,0 +1,30 @@
1
+ ## Visão Geral
2
+
3
+ Hints são blocos de alerta no estilo GitHub renderizados a partir de blockquotes Markdown com marcador `[!TYPE]`.
4
+
5
+ Use esse bloco quando o conteúdo precisar ser lido como nota, dica, aviso ou outro callout semântico.
6
+
7
+ Para texto citado de forma neutra, sem estilo de alerta, veja [Quote](/manual/content/blocks/quotes/overview/).
8
+
9
+ ## Sintaxe em Markdown
10
+
11
+ ```markdown
12
+ > [!WARNING]
13
+ > Esta operação pode interromper workers.
14
+ ```
15
+
16
+ ## Marcadores Suportados
17
+
18
+ | Marcador | Quando usar |
19
+ |----------|-------------|
20
+ | `NOTE` | Contexto extra ou material de apoio |
21
+ | `TIP` | Conselho prático ou boa prática |
22
+ | `IMPORTANT` | Informação crítica que não pode passar despercebida |
23
+ | `WARNING` | Armadilhas, ações arriscadas ou breaking changes |
24
+ | `CAUTION` | Ações de alto risco que merecem cuidado extra |
25
+
26
+ ## Observações
27
+
28
+ - O marcador deve aparecer na primeira linha do blockquote.
29
+ - O corpo do hint ainda pode conter parágrafos, listas, blocos de código e matemática.
30
+ - Marcadores desconhecidos voltam para o comportamento de uma citação comum.
@@ -0,0 +1,30 @@
1
+ ## Showcase
2
+
3
+ Hints render GitHub-style alert blockquotes directly in the reading flow.
4
+
5
+ ### Note
6
+
7
+ > [!NOTE]
8
+ > This is extra context that helps readers understand the current section.
9
+
10
+ ### Tip
11
+
12
+ > [!TIP]
13
+ > You can keep your examples short and focused to improve readability.
14
+
15
+ ### Important
16
+
17
+ > [!IMPORTANT]
18
+ > This migration changes defaults and must be reviewed before deployment.
19
+
20
+ ### Warning
21
+
22
+ > [!WARNING]
23
+ > This action may interrupt running workers in production.
24
+
25
+ ### Caution
26
+
27
+ > [!CAUTION]
28
+ > Back up your environment before applying this update.
29
+ >
30
+ > See `docs/migration.md` for the complete checklist.
@@ -0,0 +1,30 @@
1
+ ## Demonstração
2
+
3
+ Hints renderizam alertas no estilo GitHub diretamente no fluxo de leitura.
4
+
5
+ ### Note
6
+
7
+ > [!NOTE]
8
+ > Este é um contexto adicional que ajuda o leitor a entender a seção atual.
9
+
10
+ ### Tip
11
+
12
+ > [!TIP]
13
+ > Você pode manter os exemplos curtos e focados para melhorar a legibilidade.
14
+
15
+ ### Important
16
+
17
+ > [!IMPORTANT]
18
+ > Esta migração altera defaults e deve ser revisada antes do deploy.
19
+
20
+ ### Warning
21
+
22
+ > [!WARNING]
23
+ > Esta ação pode interromper workers em execução em produção.
24
+
25
+ ### Caution
26
+
27
+ > [!CAUTION]
28
+ > Faça backup do ambiente antes de aplicar esta atualização.
29
+ >
30
+ > Veja `docs/migration.md` para o checklist completo.
@@ -0,0 +1,16 @@
1
+ ## Overview
2
+
3
+ Use standard Markdown images to place screenshots, illustrations, diagrams, and product UI directly inside the reading flow.
4
+
5
+ ## Markdown Syntax
6
+
7
+ ```markdown
8
+ ![Dashboard overview](/images/example-dashboard.png)
9
+ ```
10
+
11
+ ## Good Practices
12
+
13
+ - Write descriptive alt text so the image still has meaning without the visual.
14
+ - Prefer absolute site paths such as `/images/...` for assets stored in `public/images/`.
15
+ - Use screenshots to support the text, not replace the explanation.
16
+ - When default Markdown syntax is not enough, raw HTML can be used for custom wrappers or sizing.
@@ -0,0 +1,16 @@
1
+ ## Visão Geral
2
+
3
+ Use imagens Markdown padrão para inserir screenshots, ilustrações, diagramas e interfaces diretamente no fluxo da leitura.
4
+
5
+ ## Sintaxe em Markdown
6
+
7
+ ```markdown
8
+ ![Visão geral do dashboard](/images/example-dashboard.png)
9
+ ```
10
+
11
+ ## Boas Práticas
12
+
13
+ - Escreva um texto alternativo descritivo para que a imagem continue tendo significado sem o visual.
14
+ - Prefira caminhos absolutos do site, como `/images/...`, para assets armazenados em `public/images/`.
15
+ - Use screenshots para apoiar o texto, não para substituir a explicação.
16
+ - Quando a sintaxe padrão de Markdown não for suficiente, use HTML bruto para wrappers ou tamanhos personalizados.
@@ -0,0 +1,11 @@
1
+ ## Showcase
2
+
3
+ ### Basic Image
4
+
5
+ ![Docsector Reader logo](/images/logo.png)
6
+
7
+ ### Image with Title
8
+
9
+ ![Docsector Reader logo](/images/logo.png "Docsector Reader")
10
+
11
+ The alt text remains part of the content model, so the page still communicates meaning if the image cannot be seen.
@@ -0,0 +1,11 @@
1
+ ## Demonstração
2
+
3
+ ### Imagem Básica
4
+
5
+ ![Logo do Docsector Reader](/images/logo.png)
6
+
7
+ ### Imagem com Título
8
+
9
+ ![Logo do Docsector Reader](/images/logo.png "Docsector Reader")
10
+
11
+ O texto alternativo continua fazendo parte do conteúdo, então a página ainda comunica significado mesmo quando a imagem não pode ser vista.