Editor web
Modifica la documentazione Jamdesk nel browser: sfoglia il repository collegato, modifica MDX con anteprima in tempo reale e fai commit su GitHub per avviare una build.
Modifica la tua documentazione nella dashboard Jamdesk, senza clonare il repository né aprire un terminale. Apri una pagina e modifica il suo MDX accanto a un'anteprima in tempo reale. Esegui il commit delle modifiche sul tuo branch GitHub. Ogni commit avvia una build, come un git push.
È la versione browser dell'anteprima locale e dell'estensione VS Code. Usala per una modifica rapida da qualsiasi luogo.
Gli screenshot mostrano l'interfaccia in inglese.
Apri l'editor
Fai clic su Editor nella barra laterale della dashboard. L'editor si apre sul repository collegato al tuo progetto e sul branch predefinito.
L'editor richiede un repository GitHub collegato e uno schermo ampio (desktop). Le finestre più strette mostrano un avviso "è necessaria una finestra più ampia". Ogni proprietario di progetto e membro del team può usarlo, con qualsiasi piano.
L'interfaccia
| Pannello | Funzione |
|---|---|
| Navigazione (a sinistra) | Le pagine e i gruppi del tuo sito, letti da docs.json. Filtra le pagine, apri l'editor della Configurazione (docs.json) oppure Aggiungi pagina. |
| Editor (al centro) | Un editor di codice MDX per il file aperto, con evidenziazione della sintassi e conteggio delle parole. |
| Anteprima (a destra) | Un rendering in tempo reale della pagina, aggiornato mentre digiti. Attiva Desktop / Mobile e Chiaro / Scuro per verificarne l'aspetto. |
In alto a sinistra è indicato il branch che stai modificando. Cambia branch con il selettore dei branch.
Modifica una pagina
Fai clic su una pagina nella navigazione per aprirla. Modifica l'MDX nel pannello centrale. L'anteprima si aggiorna mentre digiti. Le modifiche restano come bozza locale nel browser finché non esegui il commit. Passa da una pagina all'altra senza perdere il lavoro. Nulla arriva su GitHub finché non esegui il commit.
Aggiungi una pagina
Fai clic su Aggiungi pagina per creare una nuova pagina senza uscire dall'editor:
- Scegli un modello iniziale.
- Inserisci un titolo. Jamdesk ne ricava il nome del file.
- Scegli il gruppo di navigazione.
La nuova pagina si apre come bozza. Jamdesk scrive il nuovo file .mdx e la voce di navigazione in docs.json in un unico commit.
Esegui il commit delle modifiche
Esegui il commit delle modifiche in sospeso su GitHub per pubblicarle:
Fai clic su Commit. La finestra elenca ogni file che hai modificato (una pagina, docs.json o più file insieme).
Digita un messaggio di commit oppure fai clic su Genera perché Jamdesk ne scriva uno dal tuo diff.
Jamdesk esegue il commit delle modifiche sul branch corrente e avvia una build. Seguila nella pagina Build del progetto.
Scarta le modifiche non salvate della pagina corrente con Ripristina. Ripristina la versione committata.
Gestisci le modifiche esterne
L'editor segnala il branch quando un altro push arriva su di esso mentre stai modificando. Al commit, ogni file modificato a monte si apre come unione a tre vie. Riconcilia le due versioni lì. Le tue modifiche locali non vengono mai scartate.
Il commit dall'editor scrive un vero commit nel tuo repository. Avvia la stessa pipeline di build di un push dalla tua macchina. Se la documentazione si trova in una sottocartella del repository (configurazione monorepo), l'editor legge e scrive lì.
Requisiti
| Requisito | Dettaglio |
|---|---|
| GitHub collegato | Il progetto deve avere un repository e un branch collegati. |
| Browser desktop | Uno schermo ampio (circa 1400px+). L'editor non è disponibile su larghezze mobili. |
| Accesso | Qualsiasi proprietario o membro del progetto. Si applicano i consueti blocchi di scrittura (ad esempio, un abbonamento scaduto). |