๐ Documentazione Elerama Frontend โ
Questa documentazione รจ gestita con VitePress, un generatore di siti statici ottimizzato per documentazione tecnica.
๐ Quick Start โ
Avviare il server di sviluppo โ
bash
npm run docs:devApri http://localhost:5173/docs/ nel browser.
Build per produzione โ
bash
npm run docs:buildI file compilati saranno generati in docs/.vitepress/dist/.
Preview della build โ
bash
npm run docs:preview๐ Aggiungere Nuova Documentazione โ
- Crea un file Markdown nella cartella appropriata (es.
docs/auth/nuova-guida.md) - Aggiungi il link in
docs/.vitepress/config.tsnella sezionesidebar - Usa il frontmatter YAML (opzionale) per metadata aggiuntivi
Esempio di file con frontmatter โ
markdown
---
title: Titolo della Pagina
description: Descrizione della pagina
---
# Contenuto della Pagina
...๐จ Personalizzazione โ
La configurazione principale si trova in docs/.vitepress/config.ts:
- Sidebar: Modifica
themeConfig.sidebarper aggiungere/rimuovere voci - Navbar: Modifica
themeConfig.navper la barra di navigazione superiore - Tema: Personalizza colori e stili in
docs/.vitepress/theme/ - Home Page: Modifica
docs/index.mdper la pagina principale
๐ Struttura โ
docs/
โโโ .vitepress/
โ โโโ config.ts # Configurazione VitePress
โ โโโ cache/ # Cache (ignorata da git)
โ โโโ dist/ # Build output (ignorata da git)
โโโ index.md # Home page
โโโ auth/ # Documentazione autenticazione
โโโ cart/ # Documentazione carrello
โโโ api/ # Documentazione API
โโโ ... # Altre categorie๐ Features โ
- โ Ricerca locale integrata
- โ Syntax highlighting per codice
- โ Dark mode automatico
- โ Mobile responsive
- โ Hot reload in sviluppo
- โ SEO friendly
๐ Risorse โ
Nota: La documentazione รจ versionata insieme al codice. Aggiorna i docs quando modifichi features!