- Home
- Generatore di documentazione
- Anteprima locale per autori di contenuti
Anteprima locale per autori di contenuti
Visualizza un’anteprima della documentazione in locale prima di eseguire il push delle modifiche. Tutto ciò che serve è Docker e una directory docs/.
Prerequisiti
Sezione intitolata “Prerequisiti”- Docker Desktop installato e in esecuzione
- Il repository dei contenuti clonato in locale con una directory
docs/contenente almenoindex.mdx
Avviare il server di sviluppo
Sezione intitolata “Avviare il server di sviluppo”Dalla radice del repository dei contenuti, esegui:
docker run --rm -it \ -v "$(pwd)/docs:/content/docs" \ -p 4321:4321 \ -e MODE=dev \ ghcr.io/f5-sales-demo/docs-builder:latestApri http://localhost:4321 una volta avviato il server.
Immagini e risorse statiche
Sezione intitolata “Immagini e risorse statiche”Posiziona le immagini in una sottodirectory come docs/images/. Il container le rileva automaticamente — non sono necessari mount di volumi aggiuntivi.
Fai riferimento ad esse nel tuo MDX con un percorso relativo alla radice:
Risoluzione dei problemi
Sezione intitolata “Risoluzione dei problemi”Porta già in uso — Mappa su una porta host diversa: -p 8080:4321, quindi apri http://localhost:8080.
Contenuto non visualizzato — Verifica che docs/index.mdx esista. Controlla l’output del container per un messaggio ERROR: No content found.
Immagine obsoleta — Scarica l’ultima versione:
docker pull ghcr.io/f5-sales-demo/docs-builder:latestLetture aggiuntive
Sezione intitolata “Letture aggiuntive”- Docker Build — Dettagli sull’immagine, variabili d’ambiente e build di produzione
- Architettura — Modello di iniezione dei contenuti e design del sistema di temi