Skip to content

๐Ÿ“š 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:dev

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

Build per produzione โ€‹

bash
npm run docs:build

I file compilati saranno generati in docs/.vitepress/dist/.

Preview della build โ€‹

bash
npm run docs:preview

๐Ÿ“ Aggiungere Nuova Documentazione โ€‹

  1. Crea un file Markdown nella cartella appropriata (es. docs/auth/nuova-guida.md)
  2. Aggiungi il link in docs/.vitepress/config.ts nella sezione sidebar
  3. 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.sidebar per aggiungere/rimuovere voci
  • Navbar: Modifica themeConfig.nav per la barra di navigazione superiore
  • Tema: Personalizza colori e stili in docs/.vitepress/theme/
  • Home Page: Modifica docs/index.md per 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!

Documentazione Elerama Frontend