Tutorial completo
Dal repo vuoto al sito di documentazione online: crea un progetto, visualizza l'anteprima in locale, pubblica e, se vuoi, configura un dominio personalizzato.
Passa da un repo vuoto a un sito di documentazione online. Salta i passaggi che hai già completato.
Prerequisiti
- Un account GitHub
- Un repository con contenuti di documentazione (oppure usa lo Starter Template)
- Node.js 22.18+ o 24.11+ se vuoi installare la CLI con npm
Crea un progetto nella dashboard di Jamdesk e collega un repository.
- Segui Creazione dei progetti per impostare nome del progetto, slug e percorso della documentazione
- Se richiesto, installa la GitHub App e concedi l'accesso al repository (Collegamento a GitHub)
Visualizza in anteprima le modifiche alle pagine con la CLI di Jamdesk prima di inviarle a GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devL'anteprima locale è disponibile su http://localhost:3000. Scopri di più in Anteprima locale.
Apri una pagina .mdx nel tuo editor. Salva una modifica e aggiorna l'anteprima locale. Pubblicala con il flusso Git descritto nel passaggio successivo.
Ogni push sul branch configurato avvia una build. La build pubblica il sito sul tuo sottodominio Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainSostituisci main con il branch configurato per il tuo progetto.
La documentazione va online all'indirizzo your-project.jamdesk.app al termine della build. Per i dettagli, consulta Deployment.
Pubblica la documentazione sul tuo dominio invece che sul sottodominio Jamdesk.
- Vai su Settings → Domains nella dashboard di Jamdesk
- Aggiungi il tuo dominio (ad esempio,
docs.example.com) - Crea i record DNS mostrati nella dashboard
- Attendi il completamento della verifica e del certificato SSL
Per la risoluzione dei problemi, consulta Domini personalizzati.
Convalida del flusso end-to-end
- Il tuo sottodominio Jamdesk si carica e mostra l'ultima build
- L'anteprima locale riflette gli stessi contenuti e la stessa navigazione
- Se configurato, il dominio personalizzato è verificato e serve HTTPS
- La cronologia delle build mostra l'ultimo commit e l'autore
Facoltativo: ospita in /docs
Per pubblicare la documentazione su un sottopercorso come example.com/docs, consulta Panoramica del deployment e Hosting su sottopercorso.