๐ 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:devApri http://localhost:5173/docs/ nel browser.
Aggiungere Nuova Documentazione โ
Crea il file markdown nella cartella appropriata:
bash# Esempio touch docs/feature-x/nuova-feature.mdScrivi il contenuto seguendo la Guida alla Scrittura
Aggiungi alla sidebar in
docs/.vitepress/config.ts:typescript{ text: 'Feature X', items: [ { text: 'Nuova Feature', link: '/feature-x/nuova-feature' } ] }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 โ
- โ Configurazione completata
- ๐ Migliora i contenuti esistenti
- ๐จ Personalizza il tema se necessario
- ๐ Deploy su hosting statico
- ๐ Mantieni aggiornata la documentazione
Enjoy writing great documentation! ๐