Introduzione all'editor web

Scopri come creare e modificare la documentazione con l’editor web

L’editor web è un’interfaccia visuale per creare, modificare e revisionare la documentazione direttamente nel browser.

• Modifica visuale: Apporta modifiche alla documentazione usando un editor what-you-see-is-what-you-get (WYSIWYG) che mostra come apparirà il contenuto una volta pubblicato.
• Sincronizzazione con Git: Tutte le modifiche vengono sincronizzate automaticamente con il repository Git per mantenere il controllo delle versioni.
• Collaborazione del team: Più persone possono lavorare sulla documentazione contemporaneamente.
• Integrazione dei componenti: Aggiungi callout, blocchi di codice e altri componenti con comandi slash.
• Nessuna configurazione richiesta: Inizia a scrivere subito dalla dashboard.

Flusso di lavoro dell’Editor web

Ecco come in genere lavorerai nell’Editor web:

1. Scegli il tuo branch

   Crea un branch o apporta modifiche direttamente al branch di deployment. Ti consigliamo di creare un branch per poter visualizzare un’anteprima delle modifiche prima che vadano online.

2. Apri il file

   Apri un file esistente dalla barra laterale o creane uno nuovo usando l’esplora file.

3. Modifica i contenuti

   Apporta modifiche nell’Editor web. Prova a passare tra la modalità visuale e la modalità Markdown usando l’interruttore nell’angolo in alto a destra per capire quale preferisci.

4. Visualizza l’anteprima delle modifiche

   La modalità visuale mostra come appariranno le modifiche sul sito live. Usala per verificare che sia tutto corretto.

5. Pubblica le modifiche

   Se stai lavorando sul branch di deployment, pubblica le modifiche direttamente dall’Editor web. Sugli altri branch, crea una pull request per la revisione prima della pubblicazione.

Modalità dell’editor

L’Editor web offre due modalità per adattarsi a preferenze ed esigenze di editing diverse. Usa il toggle nell’angolo in alto a destra della barra degli strumenti dell’editor per passare da una modalità all’altra.

Modalità visiva

La modalità visiva offre un’esperienza WYSIWYG in cui le modifiche che apporti nell’editor sono esattamente quelle che verranno pubblicate sul tuo sito di documentazione. Questa modalità è ideale quando vuoi vedere in tempo reale come appariranno le modifiche.

Premi “/” per aprire il menu dei componenti e aggiungere contenuti stilizzati, callout, snippet di codice o altri componenti.

Modalità Markdown

La modalità Markdown offre accesso diretto al codice MDX alla base della tua documentazione. È ideale quando ti serve un controllo preciso sulle proprietà dei componenti o quando preferisci scrivere con la sintassi Markdown.

Prossimi passi

• Impara i concetti fondamentali di Git.
• Scopri le best practice per collaborare con i branch.
• Esplora la gestione dei contenuti con l’Editor web.
• Scopri le opzioni di pubblicazione per diversi scenari.