Skip to content

๐ŸŽ‰ VitePress - Setup Completo โ€‹

VitePress รจ stato integrato con successo nel progetto Elerama Frontend!

โœ… Cosa รจ Stato Configurato โ€‹

1. Installazione โ€‹

  • โœ… VitePress installato come dev dependency
  • โœ… Scripts npm aggiunti al package.json

2. Configurazione โ€‹

  • โœ… docs/.vitepress/config.ts - Configurazione principale
  • โœ… docs/.vitepress/theme/ - Tema personalizzato
  • โœ… docs/index.md - Homepage con hero e features
  • โœ… Sidebar completa con tutte le sezioni esistenti

3. Documentazione โ€‹

  • โœ… Tutti i file markdown esistenti integrati
  • โœ… Ricerca locale abilitata
  • โœ… Dark mode supportato
  • โœ… Syntax highlighting configurato

4. Scripts Disponibili โ€‹

bash
# Sviluppo - Avvia server locale con hot reload
npm run docs:dev

# Build - Genera sito statico per produzione
npm run docs:build

# Preview - Visualizza build di produzione in locale
npm run docs:preview

๐Ÿš€ Utilizzo โ€‹

Sviluppo Locale โ€‹

bash
npm run docs:dev

Apri http://localhost:5173/docs/ nel browser.

Aggiungere Nuova Documentazione โ€‹

  1. Crea il file markdown nella cartella appropriata:

    bash
    # Esempio
    touch docs/feature-x/nuova-feature.md
  2. Scrivi il contenuto seguendo la Guida alla Scrittura

  3. Aggiungi alla sidebar in docs/.vitepress/config.ts:

    typescript
    {
      text: 'Feature X',
      items: [
        { text: 'Nuova Feature', link: '/feature-x/nuova-feature' }
      ]
    }
  4. Preview con npm run docs:dev

๐Ÿ“ Struttura File โ€‹

docs/
โ”œโ”€โ”€ .vitepress/
โ”‚   โ”œโ”€โ”€ config.ts              # Configurazione VitePress
โ”‚   โ”œโ”€โ”€ theme/
โ”‚   โ”‚   โ”œโ”€โ”€ index.ts           # Tema personalizzato
โ”‚   โ”‚   โ””โ”€โ”€ style.css          # Stili custom
โ”‚   โ”œโ”€โ”€ cache/                 # Cache (ignorata da git)
โ”‚   โ””โ”€โ”€ dist/                  # Build output (ignorata da git)
โ”‚
โ”œโ”€โ”€ index.md                   # Homepage
โ”œโ”€โ”€ README.md                  # Panoramica progetto
โ”œโ”€โ”€ VITEPRESS_README.md        # Guida VitePress
โ”œโ”€โ”€ WRITING_GUIDE.md           # Guida scrittura docs
โ”‚
โ”œโ”€โ”€ auth/                      # Documentazione autenticazione
โ”œโ”€โ”€ cart/                      # Documentazione carrello
โ”œโ”€โ”€ api/                       # Documentazione API
โ”œโ”€โ”€ testing/                   # Guide testing
โ””โ”€โ”€ ...                        # Altre categorie

๐ŸŽจ Features Abilitate โ€‹

  • โœ… Ricerca locale - Ricerca full-text nei documenti
  • โœ… Dark mode - Supporto automatico tema scuro
  • โœ… Syntax highlighting - Evidenziazione codice GitHub style
  • โœ… Line numbers - Numeri di riga nei blocchi codice
  • โœ… Mobile responsive - Ottimizzato per mobile
  • โœ… Hot reload - Ricarica automatica in sviluppo
  • โœ… Clean URLs - URL senza .html
  • โœ… Custom containers - Tip, Warning, Danger boxes
  • โœ… Footer - Copyright e links

๐Ÿ”ง Personalizzazione โ€‹

Cambiare Colori โ€‹

Modifica docs/.vitepress/theme/style.css:

css
:root {
  --vp-c-brand-1: #your-color;
  --vp-c-brand-2: #your-color;
  --vp-c-brand-3: #your-color;
}

Aggiungere Componenti Vue โ€‹

Puoi creare componenti Vue custom in docs/.vitepress/theme/components/ e usarli nei markdown.

Modificare Navigation โ€‹

Edita docs/.vitepress/config.ts:

typescript
nav: [
  { text: 'Home', link: '/' },
  { text: 'Guide', link: '/guide/' },
  // Aggiungi qui
]

๐Ÿ“Š Build per Produzione โ€‹

bash
# Build statico
npm run docs:build

# Output in docs/.vitepress/dist/
# Deploy su qualsiasi hosting statico (Netlify, Vercel, GitHub Pages, etc.)

๐Ÿ”— Risorse โ€‹

๐ŸŽฏ Prossimi Passi โ€‹

  1. โœ… Configurazione completata
  2. ๐Ÿ“ Migliora i contenuti esistenti
  3. ๐ŸŽจ Personalizza il tema se necessario
  4. ๐Ÿš€ Deploy su hosting statico
  5. ๐Ÿ”„ Mantieni aggiornata la documentazione

Enjoy writing great documentation! ๐Ÿ“š

Documentazione Elerama Frontend