@docsector/docsector-reader 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/bin/docsector.js +1 -1
- package/package.json +1 -1
- package/public/api/manual/http-client.json +91 -0
- package/public/quasar-api/QSeparator.json +39 -0
- package/src/components/DBlockApi.vue +634 -0
- package/src/components/DBlockApiEntry.js +623 -0
- package/src/components/DBlockCodeExample.vue +22 -0
- package/src/components/DBlockSourceCode.vue +2 -4
- package/src/components/DMenu.vue +70 -25
- package/src/components/DPageTokens.vue +8 -0
- package/src/components/api-block-model.js +326 -0
- package/src/components/page-section-tokens.js +53 -1
- package/src/components/source-code-lines.js +17 -0
- package/src/pages/manual/content/blocks/api-reference.overview.en-US.md +40 -0
- package/src/pages/manual/content/blocks/api-reference.overview.pt-BR.md +40 -0
- package/src/pages/manual/content/blocks/api-reference.showcase.en-US.md +33 -0
- package/src/pages/manual/content/blocks/api-reference.showcase.pt-BR.md +33 -0
- package/src/pages/manual.index.js +28 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
## Showcase
|
|
2
|
+
|
|
3
|
+
### JSON do Quasar Sem Refatoração
|
|
4
|
+
|
|
5
|
+
Este exemplo renderiza um arquivo JSON de API real do Quasar copiado para `public/quasar-api/`.
|
|
6
|
+
|
|
7
|
+
<d-block-api src="/quasar-api/QSeparator.json" />
|
|
8
|
+
|
|
9
|
+
### JSON de SDK Genérico Com o Mesmo Schema
|
|
10
|
+
|
|
11
|
+
Este exemplo usa o mesmo modelo de seções para um cliente HTTP não-Vue e também ativa o botão opcional de Docs.
|
|
12
|
+
|
|
13
|
+
<d-block-api src="/api/manual/http-client.json" title="HTTP Client API" page-link="true" />
|
|
14
|
+
|
|
15
|
+
## Sintaxe de Autoria
|
|
16
|
+
|
|
17
|
+
```html
|
|
18
|
+
<d-block-api src="/quasar-api/QSeparator.json" />
|
|
19
|
+
|
|
20
|
+
<d-block-api
|
|
21
|
+
src="/api/manual/http-client.json"
|
|
22
|
+
title="HTTP Client API"
|
|
23
|
+
page-link="true"
|
|
24
|
+
/>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Recursos Visíveis Acima
|
|
28
|
+
|
|
29
|
+
- **Compatibilidade com JSON do Quasar** usando um arquivo real servido de `public/quasar-api/`
|
|
30
|
+
- **Suporte a APIs genéricas** sem introduzir um novo schema
|
|
31
|
+
- **Filtro local** por nomes e descrições dentro das seções carregadas
|
|
32
|
+
- **Subtabs agrupadas em props** quando múltiplas categorias existem no JSON
|
|
33
|
+
- **Link opcional para Docs** quando `meta.docsUrl` está presente e `page-link="true"` é usado
|
|
@@ -879,6 +879,34 @@ export default {
|
|
|
879
879
|
}
|
|
880
880
|
},
|
|
881
881
|
|
|
882
|
+
'/content/blocks/api-reference': {
|
|
883
|
+
config: {
|
|
884
|
+
icon: 'api',
|
|
885
|
+
status: 'new',
|
|
886
|
+
meta: {
|
|
887
|
+
description: {
|
|
888
|
+
'en-US': 'API Reference Block — Documentation of Docsector Reader',
|
|
889
|
+
'pt-BR': 'Bloco de Referência de API — Documentacao do Docsector Reader'
|
|
890
|
+
}
|
|
891
|
+
},
|
|
892
|
+
book: 'manual',
|
|
893
|
+
menu: {},
|
|
894
|
+
subpages: {
|
|
895
|
+
showcase: true
|
|
896
|
+
}
|
|
897
|
+
},
|
|
898
|
+
data: {
|
|
899
|
+
'en-US': { title: 'API Reference' },
|
|
900
|
+
'pt-BR': { title: 'Referência de API' }
|
|
901
|
+
},
|
|
902
|
+
metadata: {
|
|
903
|
+
tags: {
|
|
904
|
+
'en-US': 'api json quasar reference props methods events docs metadata custom block',
|
|
905
|
+
'pt-BR': 'api json quasar referência props métodos eventos docs metadados bloco customizado'
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
|
|
882
910
|
'/content/structures': {
|
|
883
911
|
config: null,
|
|
884
912
|
data: {
|