Tutorial end-to-end
Da un repository vuoto a un sito di documentazione online: crea un progetto, visualizzalo in locale, esegui il deploy e configura un dominio personalizzato.
Passa da un repository vuoto a un sito di documentazione online. Aggiungi un dominio personalizzato quando vuoi e salta i passaggi che hai già completato.
Prerequisiti
- Un account GitHub
- Un repository con contenuti di documentazione (oppure usa lo Starter Template)
- Node.js 20+ se vuoi installare la CLI con npm
Crea il tuo primo progetto nel dashboard di Jamdesk e collega un repository.
- Segui Creazione di progetti per impostare il nome, lo slug e il percorso della documentazione del progetto
- Se richiesto, installa la GitHub App e concedi l'accesso al repository (Collegamento a GitHub)
Usa la CLI di Jamdesk per visualizzare in anteprima le modifiche alle pagine prima di inviarle a GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devL'anteprima locale è disponibile all'indirizzo http://localhost:3000. Per saperne di più, consulta Anteprima locale.
Apri una pagina .mdx nell'editor, salva una modifica e aggiorna l'anteprima locale. Quando il risultato è corretto, pubblicala con il flusso Git del passaggio successivo.
Ogni push al branch configurato avvia un build e pubblica il risultato sul tuo sottodominio Jamdesk.
git add .
git commit -m "Add docs content"
git push origin mainSostituisci main con il branch configurato nel progetto se ne utilizzi uno diverso.
Al termine del build, la documentazione sarà disponibile all'indirizzo your-project.jamdesk.app. Consulta Deploy per ulteriori dettagli.
Pubblica la documentazione sul tuo dominio anziché sul sottodominio Jamdesk.
- Vai a Settings → Domains nel dashboard di Jamdesk
- Aggiungi il tuo dominio (ad esempio,
docs.example.com) - Crea i record DNS mostrati nel dashboard
- Attendi il completamento della verifica e della configurazione SSL
Per la risoluzione dei problemi, consulta Domini personalizzati.
Convalida del flusso end-to-end
- Il tuo sottodominio Jamdesk si carica e mostra l'ultimo build
- L'anteprima locale riflette gli stessi contenuti e la stessa navigazione
- Se configurato, il dominio personalizzato è verificato e pubblica tramite HTTPS
- La cronologia dei build mostra l'ultimo commit e l'autore
Facoltativo: ospita in /docs
Se vuoi pubblicare la documentazione in un sottopercorso come example.com/docs, consulta Panoramica del deploy e Hosting in un sottopercorso.