@docsector/docsector-reader 3.2.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 +12 -2
- package/bin/docsector.js +1 -1
- package/package.json +8 -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 +19 -1
- package/src/composables/useNavigator.js +45 -15
- 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 +7 -1
- package/src/pages/guide/i18n-and-markdown.overview.pt-BR.md +7 -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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
## Showcase
|
|
2
2
|
|
|
3
|
-
Here are code blocks in different languages
|
|
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
|
-
'/
|
|
94
|
-
'/
|
|
95
|
-
'/
|
|
96
|
-
'/
|
|
97
|
-
'/
|
|
98
|
-
'/
|
|
99
|
-
'/
|
|
100
|
-
'/
|
|
101
|
-
'/
|
|
102
|
-
'/
|
|
103
|
-
'/
|
|
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
|
|
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
|
-
'/
|
|
88
|
-
'/
|
|
89
|
-
'/
|
|
90
|
-
'/
|
|
87
|
+
'/overview' => 'PaginaVisaoGeral',
|
|
88
|
+
'/getting-started' => 'PaginaPrimeirosPassos',
|
|
89
|
+
'/configuration' => 'PaginaConfiguracao',
|
|
90
|
+
'/deployment' => 'PaginaDeploy',
|
|
91
91
|
'/plugins' => 'PaginaPlugins',
|
|
92
|
-
'/
|
|
93
|
-
'/
|
|
94
|
-
'/
|
|
95
|
-
'/
|
|
96
|
-
'/
|
|
97
|
-
'/
|
|
98
|
-
'/
|
|
99
|
-
'/
|
|
100
|
-
'/
|
|
101
|
-
'/
|
|
102
|
-
'/
|
|
103
|
-
'/
|
|
104
|
-
'/
|
|
105
|
-
'/
|
|
106
|
-
'/
|
|
107
|
-
'/
|
|
108
|
-
'/
|
|
109
|
-
'/
|
|
110
|
-
'/
|
|
111
|
-
'/
|
|
112
|
-
'/
|
|
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
|
-
|
|
3
|
+
Expandable blocks collapse secondary content behind a clickable title.
|
|
4
4
|
|
|
5
|
-
|
|
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
|
-
|
|
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
|
-
|
|
3
|
+
Blocos expansíveis recolhem conteúdo secundário atrás de um título clicável.
|
|
4
4
|
|
|
5
|
-
|
|
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
|
-
|
|
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
|
+
```
|
|
@@ -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
|
+

|
|
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
|
+

|
|
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
|
+

|
|
6
|
+
|
|
7
|
+
### Image with Title
|
|
8
|
+
|
|
9
|
+

|
|
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
|
+

|
|
6
|
+
|
|
7
|
+
### Imagem com Título
|
|
8
|
+
|
|
9
|
+

|
|
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.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Math and TeX support lets you write inline equations and display formulas directly in Markdown using KaTeX-compatible syntax.
|
|
4
|
+
|
|
5
|
+
## Inline Math
|
|
6
|
+
|
|
7
|
+
Use single dollar delimiters inside normal text:
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
Use $E = mc^2$ inside a sentence.
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Display Math
|
|
14
|
+
|
|
15
|
+
Use double dollar delimiters for standalone formulas:
|
|
16
|
+
|
|
17
|
+
```markdown
|
|
18
|
+
$$
|
|
19
|
+
\int_0^1 x^2 dx
|
|
20
|
+
$$
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Notes
|
|
24
|
+
|
|
25
|
+
- Math works in paragraphs, hints, and expandable blocks.
|
|
26
|
+
- Delimiters remain literal inside inline code and fenced code blocks.
|
|
27
|
+
- Use display math when the formula needs its own visual space.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
O suporte a Math e TeX permite escrever equações inline e fórmulas destacadas diretamente no Markdown usando sintaxe compatível com KaTeX.
|
|
4
|
+
|
|
5
|
+
## Matemática Inline
|
|
6
|
+
|
|
7
|
+
Use delimitadores com um único cifrão dentro do texto normal:
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
Use $E = mc^2$ dentro de uma frase.
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Matemática em Bloco
|
|
14
|
+
|
|
15
|
+
Use delimitadores com dois cifrões para fórmulas em destaque:
|
|
16
|
+
|
|
17
|
+
```markdown
|
|
18
|
+
$$
|
|
19
|
+
\int_0^1 x^2 dx
|
|
20
|
+
$$
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Observações
|
|
24
|
+
|
|
25
|
+
- Matemática funciona em parágrafos, hints e blocos expansíveis.
|
|
26
|
+
- Os delimitadores continuam literais dentro de código inline e blocos de código cercados.
|
|
27
|
+
- Use matemática em bloco quando a fórmula precisar de espaço visual próprio.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
## Showcase
|
|
2
|
+
|
|
3
|
+
Inline math works inside normal prose, such as $a^2 + b^2 = c^2$.
|
|
4
|
+
|
|
5
|
+
### Display Formula
|
|
6
|
+
|
|
7
|
+
$$
|
|
8
|
+
x^2 + y^2 = z^2
|
|
9
|
+
$$
|
|
10
|
+
|
|
11
|
+
### Math Inside a Hint
|
|
12
|
+
|
|
13
|
+
> [!IMPORTANT]
|
|
14
|
+
> This growth rule uses $f(x) = x^2 + 2x + 1$ in the documentation text itself.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
## Demonstração
|
|
2
|
+
|
|
3
|
+
Matemática inline funciona dentro do texto normal, como em $a^2 + b^2 = c^2$.
|
|
4
|
+
|
|
5
|
+
### Fórmula em Destaque
|
|
6
|
+
|
|
7
|
+
$$
|
|
8
|
+
x^2 + y^2 = z^2
|
|
9
|
+
$$
|
|
10
|
+
|
|
11
|
+
### Matemática Dentro de um Hint
|
|
12
|
+
|
|
13
|
+
> [!IMPORTANT]
|
|
14
|
+
> Esta regra de crescimento usa $f(x) = x^2 + 2x + 1$ dentro do próprio texto da documentação.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Mermaid diagrams are authored with fenced code blocks that use the `mermaid` language identifier.
|
|
4
|
+
|
|
5
|
+
Docsector turns those definitions into responsive SVG diagrams directly inside the page, so flowcharts, sequence diagrams, and similar visuals can live next to the written explanation.
|
|
6
|
+
|
|
7
|
+
## Basic Syntax
|
|
8
|
+
|
|
9
|
+
````markdown
|
|
10
|
+
```mermaid
|
|
11
|
+
flowchart TD
|
|
12
|
+
A[Start] --> B[Finish]
|
|
13
|
+
```
|
|
14
|
+
````
|
|
15
|
+
|
|
16
|
+
## What Docsector Handles
|
|
17
|
+
|
|
18
|
+
- Lazy-loads Mermaid only when a page actually contains a diagram
|
|
19
|
+
- Renders diagrams as responsive SVG output
|
|
20
|
+
- Rebuilds the diagram when the reader switches between light and dark mode
|
|
21
|
+
- Shows a safe error state if the Mermaid syntax is invalid
|
|
22
|
+
- Decodes `{` and `}` before rendering so i18n-safe source still works
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Diagramas Mermaid são escritos com fences de código usando o identificador de linguagem `mermaid`.
|
|
4
|
+
|
|
5
|
+
O Docsector transforma essas definições em SVGs responsivos dentro da própria página, permitindo documentar fluxos, sequências e outros diagramas lado a lado com a explicação em texto.
|
|
6
|
+
|
|
7
|
+
## Sintaxe Básica
|
|
8
|
+
|
|
9
|
+
````markdown
|
|
10
|
+
```mermaid
|
|
11
|
+
flowchart TD
|
|
12
|
+
A[Início] --> B[Fim]
|
|
13
|
+
```
|
|
14
|
+
````
|
|
15
|
+
|
|
16
|
+
## O Que o Docsector Faz
|
|
17
|
+
|
|
18
|
+
- Carrega o Mermaid sob demanda, apenas quando a página realmente contém diagramas
|
|
19
|
+
- Renderiza a saída como SVG responsivo
|
|
20
|
+
- Reconstrói o diagrama quando o leitor alterna entre modo claro e escuro
|
|
21
|
+
- Mostra um estado de erro seguro se a sintaxe Mermaid estiver inválida
|
|
22
|
+
- Decodifica `{` e `}` antes da renderização para manter compatibilidade com conteúdo seguro para i18n
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Overview
|
|
2
|
+
|
|
3
|
+
Use ordered lists when the sequence of the items matters.
|
|
4
|
+
|
|
5
|
+
They are a good fit for installation steps, review checklists, migrations, or any process the reader should follow in order.
|
|
6
|
+
|
|
7
|
+
## Markdown Syntax
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
1. Install dependencies
|
|
11
|
+
2. Start the dev server
|
|
12
|
+
3. Open the documentation site
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Notes
|
|
16
|
+
|
|
17
|
+
- Ordered lists communicate progression or priority.
|
|
18
|
+
- Nested ordered lists work the same way as nested bullet lists.
|
|
19
|
+
- Keep each item concise when the list represents a procedure.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Visão Geral
|
|
2
|
+
|
|
3
|
+
Use listas ordenadas quando a sequência dos itens importa.
|
|
4
|
+
|
|
5
|
+
Elas são ideais para passos de instalação, checklists de revisão, migrações ou qualquer processo que o leitor deva seguir em ordem.
|
|
6
|
+
|
|
7
|
+
## Sintaxe em Markdown
|
|
8
|
+
|
|
9
|
+
```markdown
|
|
10
|
+
1. Instale as dependências
|
|
11
|
+
2. Inicie o servidor de desenvolvimento
|
|
12
|
+
3. Abra o site de documentação
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Observações
|
|
16
|
+
|
|
17
|
+
- Listas ordenadas comunicam progressão ou prioridade.
|
|
18
|
+
- Listas ordenadas aninhadas funcionam da mesma forma que listas com marcadores aninhadas.
|
|
19
|
+
- Quando a lista representa um procedimento, mantenha cada item direto ao ponto.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
## Showcase
|
|
2
|
+
|
|
3
|
+
### Sequential Steps
|
|
4
|
+
|
|
5
|
+
1. Create the page entry in the registry.
|
|
6
|
+
2. Write the localized overview markdown.
|
|
7
|
+
3. Add a showcase page with real examples.
|
|
8
|
+
4. Run tests and the build.
|
|
9
|
+
|
|
10
|
+
### Nested Sequence
|
|
11
|
+
|
|
12
|
+
1. Prepare the change.
|
|
13
|
+
1. Confirm the route path.
|
|
14
|
+
2. Check the required markdown files.
|
|
15
|
+
2. Validate the result.
|
|
16
|
+
1. Run the focused tests.
|
|
17
|
+
2. Build the site.
|
|
18
|
+
|
|
19
|
+
### When Ordered Lists Fit Best
|
|
20
|
+
|
|
21
|
+
Use numbered lists when the reader should follow a procedure, a checklist, or a lifecycle in a specific order.
|