@docsector/docsector-reader 0.2.0 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "A documentation rendering engine built with Vue 3, Quasar v2 and Vite. Transform Markdown into beautiful, navigable documentation sites.",
   "productName": "Docsector Reader",
   "author": "Rodrigo de Araujo Vieira",

package/src/layouts/SystemLayout.vue

@@ -1,4 +1,5 @@
-<template lang="pug">
-q-layout(view="lHh lpR lFr")
-  router-view
+<template>
+  <q-layout view="lHh lpR lFr">
+    <router-view />
+  </q-layout>
 </template>

package/src/pages/guide/getting-started.overview.en-US.md

@@ -10,50 +10,68 @@ Docsector Reader is a **documentation rendering engine** built with Vue 3, Quasa
 
 ## Installation
 
+Scaffold a new documentation project with the CLI:
+
 ```bash
-npx degit docsector/docsector-reader my-docs
+npx @docsector/docsector-reader init my-docs
 cd my-docs
 npm install
 ```
 
+This creates a ready-to-use project with all necessary configuration files, a sample page registry, and i18n setup.
+
 ## Development Server
 
 Start the dev server with hot-reload:
 
 ```bash
-npx quasar dev
+npx docsector dev
 ```
 
 The documentation site will be available at **http://localhost:8181**.
 
+You can also specify a custom port:
+
+```bash
+npx docsector dev --port 3000
+```
+
 ## Production Build
 
 Build an optimized SPA for deployment:
 
 ```bash
-npx quasar build
+npx docsector build
 ```
 
 The output is placed in `dist/spa/` — ready to deploy to any static hosting.
 
+To preview the production build locally:
+
+```bash
+npx docsector serve
+```
+
 ## Project Structure
 
-The project follows a standard Quasar v2 layout with documentation-specific conventions:
+After `init`, your project will have this structure:
 
-- `docsector.config.js` — Branding, links, languages
+- `docsector.config.js` — Branding, links, languages, GitHub config
+- `quasar.config.js` — Thin wrapper using `createQuasarConfig()` from the package
+- `index.html` — HTML entry point with title and meta tags
 - `src/pages/index.js` — Page registry (routes and metadata)
 - `src/pages/guide/` — Guide-type pages (Markdown files)
 - `src/pages/manual/` — Manual-type pages (Markdown files)
-- `src/components/` — Docsector Vue components
-- `src/composables/` — Vue composables (useNavigator)
-- `src/store/` — Vuex 4 modules
-- `src/i18n/` — Language files (.hjson) and loader
-- `src/layouts/` — DefaultLayout and SystemLayout
-- `src/boot/` — Boot files (store, i18n, QZoom, axios)
+- `src/i18n/index.js` — i18n loader using `buildMessages()` from the package
+- `src/i18n/tags.hjson` — Search keywords per route and locale
+- `public/` — Static assets (logo, favicon, images)
+
+The rendering engine (components, layouts, router, store, composables) lives inside the `@docsector/docsector-reader` package — you only maintain your content and configuration.
 
 ## Next Steps
 
 - Configure your project branding in **docsector.config.js**
 - Define your pages in **src/pages/index.js**
 - Write your documentation in **Markdown**
+- Add search keywords in **src/i18n/tags.hjson**
 - Customize themes and appearance

package/src/pages/guide/getting-started.overview.pt-BR.md

@@ -10,50 +10,68 @@ Docsector Reader é um **motor de renderização de documentação** construído
 
 ## Instalação
 
+Crie um novo projeto de documentação com o CLI:
+
 ```bash
-npx degit docsector/docsector-reader my-docs
+npx @docsector/docsector-reader init my-docs
 cd my-docs
 npm install
 ```
 
+Isso cria um projeto pronto para uso com todos os arquivos de configuração, um registro de páginas de exemplo e setup de i18n.
+
 ## Servidor de Desenvolvimento
 
 Inicie o servidor dev com hot-reload:
 
 ```bash
-npx quasar dev
+npx docsector dev
 ```
 
 O site de documentação estará disponível em **http://localhost:8181**.
 
+Você também pode especificar uma porta personalizada:
+
+```bash
+npx docsector dev --port 3000
+```
+
 ## Build de Produção
 
 Gere um SPA otimizado para deploy:
 
 ```bash
-npx quasar build
+npx docsector build
 ```
 
 O output fica em `dist/spa/` — pronto para deploy em qualquer hosting estático.
 
+Para visualizar a build de produção localmente:
+
+```bash
+npx docsector serve
+```
+
 ## Estrutura do Projeto
 
-O projeto segue o layout padrão do Quasar v2 com convenções específicas para documentação:
+Após o `init`, seu projeto terá esta estrutura:
 
-- `docsector.config.js` — Branding, links, idiomas
+- `docsector.config.js` — Branding, links, idiomas, config do GitHub
+- `quasar.config.js` — Wrapper fino usando `createQuasarConfig()` do pacote
+- `index.html` — Ponto de entrada HTML com título e meta tags
 - `src/pages/index.js` — Registro de páginas (rotas e metadata)
 - `src/pages/guide/` — Páginas tipo guia (arquivos Markdown)
 - `src/pages/manual/` — Páginas tipo manual (arquivos Markdown)
-- `src/components/` — Componentes Vue do Docsector
-- `src/composables/` — Composables Vue (useNavigator)
-- `src/store/` — Módulos Vuex 4
-- `src/i18n/` — Arquivos de idioma (.hjson) e loader
-- `src/layouts/` — DefaultLayout e SystemLayout
-- `src/boot/` — Boot files (store, i18n, QZoom, axios)
+- `src/i18n/index.js` — Loader i18n usando `buildMessages()` do pacote
+- `src/i18n/tags.hjson` — Palavras-chave de busca por rota e idioma
+- `public/` — Assets estáticos (logo, favicon, imagens)
+
+O motor de renderização (componentes, layouts, router, store, composables) fica dentro do pacote `@docsector/docsector-reader` — você só mantém seu conteúdo e configuração.
 
 ## Próximos Passos
 
 - Configure o branding do seu projeto em **docsector.config.js**
 - Defina suas páginas em **src/pages/index.js**
 - Escreva sua documentação em **Markdown**
+- Adicione palavras-chave de busca em **src/i18n/tags.hjson**
 - Personalize temas e aparência