@docsector/docsector-reader 0.2.6 → 0.2.8

package/bin/docsector.js

@@ -23,7 +23,7 @@ const packageRoot = resolve(__dirname, '..')
 const args = process.argv.slice(2)
 const command = args[0]
 
-const VERSION = '0.2.3'
+const VERSION = '0.2.8'
 
 const HELP = `
   Docsector Reader v${VERSION}
@@ -71,7 +71,7 @@ function getTemplatePackageJson (name) {
       serve: 'docsector serve'
     },
     dependencies: {
-      '@docsector/docsector-reader': '^0.2.3',
+      '@docsector/docsector-reader': '^0.2.8',
       '@quasar/extras': '^1.16.12',
       'quasar': '^2.16.6',
       'vue': '^3.5.13',
@@ -164,13 +164,106 @@ export default buildMessages({ langModules, mdModules, pages, boot })
 
 const TEMPLATE_I18N_HJSON = `\
 {
-  // Main navigation and UI labels for your documentation
-  nav: {
-    overview: Overview
+  // @ Pages — dynamic content injected by buildMessages
+  _: {
+    home: {
+      texts: [
+        'The official documentation of ',
+        'Built with ',
+        'Start exploring the docs below!'
+      ]
+    }
+
+    guide: {}
+  }
+
+  // @ Page actions
+  page: {
+    edit: {
+      github: {
+        start: 'Start this page'
+        complete: 'Complete this page'
+        edit: 'Edit this page'
+      }
+      progress: 'Translation Progress'
+      translations: 'Available translations'
+      anchor: 'Anchor navigation'
+      of: 'of'
+    }
+    nav: {
+      prev: 'Previous page'
+      next: 'Next page'
+    }
+  }
+
+  // @ Menu
+  menu: {
+    search: 'Search'
+
+    home: 'Home'
+    changelog: 'Changelog'
+    roadmap: 'Roadmap'
+    sponsor: 'Sponsor'
+    explore: 'Explore GitHub Repositories'
+
+    status: {
+      empty: {
+        _: 'empty'
+        tooltip: 'This page is empty!'
+      }
+      draft: {
+        _: 'draft'
+        tooltip: 'This page is under construction.'
+      }
+    }
+
+    settings: 'Settings'
+
+    _404: '404 Error - Not Found'
+  }
+
+  // @ Submenus (tabs)
+  submenu: {
+    guides: 'Guides'
+    manuals: 'Manuals'
+    references: 'References'
+
+    overview: 'Overview'
+    showcase: 'Showcase'
+    versus: 'Vs'
+
+    changelog: 'Changelog'
+  }
+
+  // @ System
+  system: {
+    documentation: 'Documentation'
+    support: 'Sponsor this project'
+    backToTop: 'Back to top'
+  }
+
+  // @ Settings
+  settings: {
+    general: {
+      _: 'General Settings'
+      language: {
+        _: 'Language'
+      }
+    }
+    appearance: {
+      _: 'Appearance'
+      background: {
+        _: 'Background Color'
+      }
+    }
   }
 
-  // Page-specific translations (auto-loaded from pages/*.md)
-  pages: {}
+  changelog: {}
+
+  _a: ' and '
+  _o: ' or '
+  _f: ' files '
+  _s: 'Source Code'
 }
 `
 
@@ -218,7 +311,8 @@ export default {
   meta: {
     'en-US': {
       overview: {
-        _translations: null
+        _translations: null,
+        _sections: null
       }
     }
   }
@@ -227,41 +321,306 @@ export default {
 
 const TEMPLATE_BOOT_PAGE = `\
 <template>
-  <q-page class="flex flex-center column q-pa-xl">
-    <h1 class="text-h3 text-weight-bold q-mb-md">
-      Welcome to your Documentation
-    </h1>
-    <p class="text-subtitle1 text-grey-7">
-      Edit <code>src/pages/@/BootPage.vue</code> to customize this page.
-    </p>
-    <q-btn
-      color="primary"
-      label="Getting Started"
-      to="/en-US/guide/getting-started/overview"
-      class="q-mt-lg"
-    />
+<q-page-container>
+  <q-page class="boot-page">
+    <!-- Hero Section -->
+    <div class="hero-section">
+      <div class="hero-content">
+        <div class="hero-icon-container">
+          <q-icon name="auto_stories" size="64px" color="white" />
+        </div>
+        <h1 class="hero-title">{{ projectName }}</h1>
+        <p class="hero-subtitle">{{ $t('_.home.texts[0]') }}{{ projectName }}</p>
+        <p class="hero-description">{{ $t('_.home.texts[2]') }}</p>
+        <div class="hero-actions">
+          <q-btn
+            unelevated
+            color="white"
+            text-color="primary"
+            label="Get Started"
+            icon="rocket_launch"
+            to="/guide/getting-started/overview"
+            class="hero-btn"
+            size="lg"
+            no-caps
+          />
+          <q-btn
+            v-if="projectUrl !== '#'"
+            outline
+            color="white"
+            label="GitHub"
+            icon="fab fa-github"
+            @click="openURL(projectUrl)"
+            class="hero-btn"
+            size="lg"
+            no-caps
+          />
+        </div>
+      </div>
+    </div>
+
+    <!-- Features Section -->
+    <div class="features-section">
+      <div class="features-grid">
+        <div class="feature-card">
+          <q-icon name="edit_note" size="40px" color="primary" />
+          <h3>Markdown Powered</h3>
+          <p>Write your documentation in Markdown. Pages are automatically converted into beautiful, navigable content.</p>
+        </div>
+        <div class="feature-card">
+          <q-icon name="translate" size="40px" color="primary" />
+          <h3>Multi-language</h3>
+          <p>Built-in i18n support. Add translations by creating locale files — no extra configuration needed.</p>
+        </div>
+        <div class="feature-card">
+          <q-icon name="palette" size="40px" color="primary" />
+          <h3>Beautiful UI</h3>
+          <p>Powered by Quasar Framework. Responsive, accessible, and production-ready out of the box.</p>
+        </div>
+        <div class="feature-card">
+          <q-icon name="bolt" size="40px" color="primary" />
+          <h3>Lightning Fast</h3>
+          <p>Vite-powered dev server with hot-reload. See your changes instantly as you write.</p>
+        </div>
+        <div class="feature-card">
+          <q-icon name="search" size="40px" color="primary" />
+          <h3>Full-text Search</h3>
+          <p>Instant client-side search across all your documentation pages and translations.</p>
+        </div>
+        <div class="feature-card">
+          <q-icon name="settings" size="40px" color="primary" />
+          <h3>Easy Configuration</h3>
+          <p>One config file for branding, links, languages, and GitHub integration.</p>
+        </div>
+      </div>
+    </div>
+
+    <!-- Quick Start Section -->
+    <div class="quickstart-section">
+      <h2 class="section-title">Quick Links</h2>
+      <div class="quickstart-grid">
+        <q-card flat bordered class="quickstart-card" clickable @click="$router.push('/guide/getting-started/overview')">
+          <q-card-section horizontal>
+            <q-card-section class="flex flex-center" style="width: 60px;">
+              <q-icon name="flag" size="28px" color="primary" />
+            </q-card-section>
+            <q-card-section>
+              <div class="text-subtitle1 text-weight-bold">Getting Started</div>
+              <div class="text-caption text-grey-7">Installation, setup, and your first page</div>
+            </q-card-section>
+            <q-space />
+            <q-card-section class="flex flex-center">
+              <q-icon name="chevron_right" color="grey-5" />
+            </q-card-section>
+          </q-card-section>
+        </q-card>
+      </div>
+    </div>
+
+    <!-- Footer -->
+    <div class="boot-footer">
+      <p>{{ $t('_.home.texts[1]') }}
+        <a :href="projectUrl" target="_blank" class="footer-link">Docsector Reader</a>
+      </p>
+    </div>
   </q-page>
+</q-page-container>
 </template>
 
 <script setup>
+import { openURL } from 'quasar'
+import docsectorConfig from 'docsector.config.js'
+
 defineOptions({ name: 'BootPage' })
+
+const projectName = docsectorConfig.branding?.name || 'My Documentation'
+const projectUrl = docsectorConfig.links?.github || '#'
 </script>
+
+<style lang="sass" scoped>
+.boot-page
+  padding: 0 !important
+
+// Hero
+.hero-section
+  background: linear-gradient(135deg, #655529 0%, #8b7340 50%, #a08850 100%)
+  color: white
+  padding: 80px 24px 60px
+  text-align: center
+  position: relative
+  overflow: hidden
+
+  &::before
+    content: ''
+    position: absolute
+    top: -50%
+    left: -50%
+    width: 200%
+    height: 200%
+    background: radial-gradient(circle, rgba(255,255,255,0.05) 0%, transparent 60%)
+    animation: pulse 8s ease-in-out infinite
+
+@keyframes pulse
+  0%, 100%
+    transform: scale(1)
+  50%
+    transform: scale(1.1)
+
+.hero-content
+  position: relative
+  z-index: 1
+  max-width: 700px
+  margin: 0 auto
+
+.hero-icon-container
+  margin-bottom: 24px
+  .q-icon
+    opacity: 0.9
+
+.hero-title
+  font-size: 2.8rem
+  font-weight: 700
+  margin: 0 0 12px
+  line-height: 1.2
+  letter-spacing: -0.02em
+
+.hero-subtitle
+  font-size: 1.2rem
+  opacity: 0.9
+  margin: 0 0 8px
+  font-weight: 400
+
+.hero-description
+  font-size: 1rem
+  opacity: 0.7
+  margin: 0 0 32px
+
+.hero-actions
+  display: flex
+  gap: 16px
+  justify-content: center
+  flex-wrap: wrap
+
+.hero-btn
+  border-radius: 8px
+  padding: 8px 28px
+  font-weight: 600
+
+// Features
+.features-section
+  padding: 60px 24px
+  max-width: 1100px
+  margin: 0 auto
+
+.features-grid
+  display: grid
+  grid-template-columns: repeat(auto-fit, minmax(280px, 1fr))
+  gap: 24px
+
+.feature-card
+  padding: 28px 24px
+  border-radius: 12px
+  border: 1px solid #e8e8e8
+  transition: transform 0.2s, box-shadow 0.2s
+  text-align: center
+
+  &:hover
+    transform: translateY(-4px)
+    box-shadow: 0 8px 25px rgba(0,0,0,0.08)
+
+  h3
+    font-size: 1.1rem
+    font-weight: 600
+    margin: 16px 0 8px
+    color: #333
+
+  p
+    font-size: 0.9rem
+    color: #666
+    line-height: 1.5
+    margin: 0
+
+// Quick Start
+.quickstart-section
+  padding: 40px 24px 60px
+  max-width: 700px
+  margin: 0 auto
+
+.section-title
+  font-size: 1.6rem
+  font-weight: 700
+  text-align: center
+  margin: 0 0 24px
+  color: #333
+
+.quickstart-grid
+  display: flex
+  flex-direction: column
+  gap: 12px
+
+.quickstart-card
+  border-radius: 10px
+  transition: box-shadow 0.2s
+  cursor: pointer
+
+  &:hover
+    box-shadow: 0 4px 15px rgba(0,0,0,0.1)
+
+// Footer
+.boot-footer
+  text-align: center
+  padding: 24px
+  border-top: 1px solid #e8e8e8
+  color: #999
+  font-size: 0.85rem
+
+  .footer-link
+    color: #655529
+    text-decoration: none
+    font-weight: 500
+
+    &:hover
+      text-decoration: underline
+
+// Dark mode
+body.body--dark
+  .feature-card
+    border-color: #333
+    h3
+      color: #e0e0e0
+    p
+      color: #aaa
+
+  .section-title
+    color: #e0e0e0
+
+  .boot-footer
+    border-color: #333
+    .footer-link
+      color: #c4a856
+</style>
 `
 
 const TEMPLATE_404_PAGE = `\
 <template>
+<q-page-container>
   <q-page class="flex flex-center column q-pa-xl">
-    <h1 class="text-h3 text-weight-bold q-mb-md">404</h1>
-    <p class="text-subtitle1 text-grey-7">
-      Page not found.
+    <q-icon name="search_off" size="80px" color="grey-5" class="q-mb-lg" />
+    <h1 class="text-h3 text-weight-bold q-mb-sm" style="color: #333;">404</h1>
+    <p class="text-subtitle1 text-grey-6 q-mb-lg">
+      The page you're looking for doesn't exist.
     </p>
     <q-btn
-      flat
+      unelevated
       color="primary"
-      label="Go Home"
+      label="Back to Home"
+      icon="home"
       to="/"
+      no-caps
+      style="border-radius: 8px;"
     />
   </q-page>
+</q-page-container>
 </template>
 
 <script setup>
@@ -310,29 +669,64 @@ npm-debug.log*
 `
 
 const TEMPLATE_GETTING_STARTED_MD = `\
-# Getting Started
-
-Welcome to your documentation project!
-
 ## Installation
 
+Create a new Docsector documentation project:
+
 \\\`\\\`\\\`bash
+npx @docsector/docsector-reader init my-docs
+cd my-docs
 npm install
 \\\`\\\`\\\`
 
-## Development
+## Development Server
+
+Start the development server with hot-reload:
 
 \\\`\\\`\\\`bash
 npm run dev
 \\\`\\\`\\\`
 
-Your documentation will be available at **http://localhost:8181**.
+Open **http://localhost:8181** in your browser.
+
+## Project Structure
+
+Here's an overview of the project files:
+
+| File / Folder | Description |
+| --- | --- |
+| \\\`docsector.config.js\\\` | Branding, links, languages, and GitHub config |
+| \\\`quasar.config.js\\\` | Quasar/Vite build configuration (via factory) |
+| \\\`src/pages/index.js\\\` | Page registry — defines all documentation pages |
+| \\\`src/pages/boot.js\\\` | Boot metadata for the home page |
+| \\\`src/pages/@/\\\` | Special pages (Home, 404) |
+| \\\`src/pages/guide/\\\` | Guide pages (Markdown files) |
+| \\\`src/i18n/languages/\\\` | Translation files (HJSON format) |
+| \\\`src/css/app.sass\\\` | Custom styles |
+| \\\`public/images/\\\` | Static assets (logo, flags, icons) |
+
+## Adding a Page
+
+1. Register the page in \\\`src/pages/index.js\\\`
+2. Create the Markdown file at \\\`src/pages/{type}/{path}.overview.{lang}.md\\\`
+3. The page will automatically appear in the sidebar navigation
 
-## Next Steps
+## Customization
+
+Edit \\\`docsector.config.js\\\` to change:
+
+- **Branding** — logo, name, version
+- **Links** — GitHub, changelog, sponsor
+- **Languages** — add or remove supported locales
+- **GitHub** — edit page base URL
+
+## Building for Production
+
+\\\`\\\`\\\`bash
+npm run build
+\\\`\\\`\\\`
 
-- Edit pages in \\\`src/pages/\\\`
-- Add languages in \\\`src/i18n/languages/\\\`
-- Customize branding in \\\`docsector.config.js\\\`
+The optimized SPA output will be in \\\`dist/spa/\\\`.
 `
 
 // =============================================================================
@@ -409,8 +803,7 @@ function initProject (name) {
     'src/i18n/languages',
     'src/pages',
     'src/pages/@',
-    'src/pages/getting-started',
-    'src/pages/getting-started/en-US',
+    'src/pages/guide',
     'public',
     'public/images',
     'public/images/icons',
@@ -436,7 +829,7 @@ function initProject (name) {
     ['src/pages/boot.js', TEMPLATE_PAGES_BOOT],
     ['src/pages/@/BootPage.vue', TEMPLATE_BOOT_PAGE],
     ['src/pages/@/404Page.vue', TEMPLATE_404_PAGE],
-    ['src/pages/getting-started/en-US/overview.md', TEMPLATE_GETTING_STARTED_MD]
+    ['src/pages/guide/getting-started.overview.en-US.md', TEMPLATE_GETTING_STARTED_MD]
   ]
 
   for (const [filePath, content] of files) {
@@ -466,9 +859,8 @@ function initProject (name) {
   console.log('            ├── @/')
   console.log('            │   ├── BootPage.vue')
   console.log('            │   └── 404Page.vue')
-  console.log('            └── getting-started/')
-  console.log('                └── en-US/')
-  console.log('                    └── overview.md')
+  console.log('            └── guide/')
+  console.log('                └── getting-started.overview.en-US.md')
 
   console.log('\n  Next steps:\n')
   console.log(`    cd ${name}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "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/quasar.factory.js

@@ -180,6 +180,16 @@ export function createQuasarConfig (options = {}) {
           'hjson', 'q-colorize-mixin'
         ]
 
+        // Exclude boot files from pre-bundling.
+        // Boot files (especially boot/i18n) import the consumer's src/i18n/index.js
+        // which uses import.meta.glob — a compile-time Vite directive that only
+        // works in source files. If pre-bundled, the glob calls become dead code
+        // and no i18n messages are loaded.
+        viteConf.optimizeDeps.exclude = [
+          ...(viteConf.optimizeDeps.exclude || []),
+          'boot/i18n', 'boot/store', 'boot/QZoom', 'boot/axios'
+        ]
+
         if (!isStandalone) {
           // --- Consumer project mode ---
           // Allow Vite to serve files from the package root (needed for symlinked/npm-linked packages)