GitBook è una piattaforma che consente a te e al tuo team di creare e collaborare su siti di documentazione. GitBook lo fa usando concetti di controllo della versione, come branching e merging.

Poiché molti membri del team possono lavorare su un unico sito di documentazione, GitBook ti consente di creare e gestire bozze separate. È inoltre possibile visualizzare le differenze tra la bozza corrente e la copia della documentazione principale.

Sono disponibili diversi tipi di blocco da aggiungere alle pagine wiki. Ciò include intestazioni, paragrafi, immagini, suggerimenti, tabelle, blocchi di codice, allegati di file e altro ancora.

Come aggiungere blocchi di contenuto in GitBook

È possibile visualizzare un elenco dei blocchi di contenuto disponibili da aggiungere a una pagina. Puoi farlo facendo clic in un punto qualsiasi della pagina e facendo clic su più simbolo che appare. Puoi anche cercare direttamente un blocco di contenuti specifico.

Puoi aggiungere contenuti usando Markdown. Se non hai mai usato Markdown prima, puoi saperne di più

instagram viewer
come iniziare con Markdown. Puoi anche leggere di più su perché Markdown è così popolare.

Come aggiungere paragrafi, elenchi, citazioni o blocchi di codice

Per aggiungere elenchi, paragrafi, virgolette, blocchi di codice o altri semplici blocchi di contenuto, apri il menu a discesa e seleziona uno dei tipi disponibili.

  1. In una pagina del tuo sito di documentazione, fai clic su più pulsante nella posizione in cui desideri aggiungere il contenuto.
  2. Dal menu a discesa, puoi scorrere l'elenco per visualizzare le diverse opzioni di contenuto.
  3. Da qui, seleziona qualsiasi tipo di contenuto semplice, come un paragrafo, un blocco di codice, un'intestazione o una citazione. GitBook cambierà automaticamente il contenuto in modo che corrisponda al formato che hai selezionato.

Come aggiungere immagini o allegati di file

Per aggiungere immagini, utilizzare il menu a discesa per selezionare il immagini opzione di blocco dei contenuti. Per aggiungere file, seleziona il Inserisci file opzione invece. Puoi quindi utilizzare il pannello di destra per gestire le immagini e i file caricati.

  1. Apri una pagina sul tuo sito di documentazione. Clicca sul più pulsante per aprire il menu a discesa per i blocchi di contenuto disponibili.
  2. Selezionare Inserisci immagini.
  3. Nel pannello di destra visualizzato, ci sono tre schede. Il File la scheda ti consente di caricare il tuo file immagine. Il URL la scheda ti consente di collegarti a un'immagine online. Puoi anche aprire il Spruzza scheda. Qui è dove puoi selezionare le foto esistenti che non richiedono l'attribuzione.
  4. Dopo aver aggiunto un'immagine, fare clic su tre punti pulsante situato nell'angolo in alto a sinistra dell'immagine. Si aprirà un menu a discesa in cui è possibile allineare l'immagine o eliminarla. Puoi anche dare all'immagine una didascalia.
  5. Per inserire file, posiziona il cursore in un punto qualsiasi di una pagina del tuo sito di documentazione. Clicca sul più pulsante per aprire il menu a discesa dei tipi di blocco di contenuto. Questa volta, fai clic su inserire file opzione.
  6. Apparirà un pannello simile a destra, che ti consentirà di caricare qualsiasi file allegato anziché un'immagine. Clicca su Sfoglia i file per selezionare un file memorizzato localmente sul tuo computer.
  7. Il file apparirà nell'elenco. Fai clic sul file e GitBook creerà un blocco di contenuto con il file allegato nella pagina che hai aperto. Facendo clic su questo blocco di contenuto verrà scaricato il file allegato.

Come aggiungere suggerimenti

Puoi anche aggiungere suggerimenti alla tua pagina. Puoi cambiare l'icona per i suggerimenti in modo che utilizzino il rosso per il pericolo, l'arancione per l'avvertimento, il blu per le informazioni o il verde per il successo.

  1. Per aggiungere un suggerimento, fare clic su più pulsante per aprire il menu a discesa per i blocchi di contenuto disponibili.
  2. Selezionare Suggerimento.
  3. Questo aggiungerà un suggerimento alla tua pagina. Per impostazione predefinita, il tipo di suggerimento è "informazioni" e contiene un'icona blu.
  4. È possibile modificare il tipo di suggerimento facendo clic sull'icona. Questo scorrerà attraverso i quattro diversi tipi di suggerimento.

Come aggiungere tabelle

È possibile aggiungere tabelle selezionando il tavolo opzione dall'elenco a discesa. Una volta che hai la tabella sulla pagina, puoi aggiungere nuove righe o colonne. Puoi anche modificare i nomi e i tipi di dati delle colonne e modificare i dati all'interno della tabella.

  1. Clicca sul più pulsante per aprire il menu a discesa per i blocchi di contenuto disponibili.
  2. Selezionare Tavolo.
  3. Fare clic sull'intestazione di una colonna nella tabella. Si aprirà un nuovo menu più piccolo, in cui puoi cambiare il nome della colonna selezionata. Questo menu consente anche di eliminare o nascondere la colonna selezionata. Per alcuni tipi di dati di colonna, puoi anche allineare il contenuto all'interno della colonna.
  4. Per impostazione predefinita, il tipo di dati selezionato per le colonne è "Testo". Fare clic sul pulsante con il T simbolo per modificare il tipo di dati. Puoi cambiarlo in un numero, una casella di controllo, un menu a discesa, un allegato di file, una valutazione o altro.
  5. Clicca sul icona a sei punti vicino all'angolo in alto a sinistra della tabella. Qui puoi inserire nuove colonne e righe o eliminare l'intera tabella. Puoi anche nascondere o mostrare determinate colonne o modificare altre proprietà per la tabella.

Come aggiungere blocchi di collegamento alla pagina

I blocchi di collegamento di pagina sono collegamenti che occupano l'intera riga della pagina. Quando aggiungi il link, devi collegarti alla pagina che si aprirà quando qualcuno fa clic su di essa.

  1. Clicca sul più pulsante per aprire il menu a discesa per i blocchi di contenuto disponibili.
  2. Clicca su Collegamento alla pagina.
  3. Dal nuovo menu a discesa, scegli la pagina a cui ti stai collegando.
  4. Il link della tua pagina apparirà all'interno di un blocco sulla pagina.

Utilizzo di GitBook per la documentazione

GitBook è uno strumento di documentazione che utilizza concetti di controllo della versione come branching e merging. Ciò consente a più di un membro del team di lavorare contemporaneamente sulla documentazione. Aiuta anche a gestire eventuali conflitti che si verificano.

Puoi aggiungere tutti i tipi di blocchi di contenuto a una pagina. Puoi utilizzare intestazioni, paragrafi, blocchi di codice o punti elenco per riformattare il contenuto. Puoi modificare il tipo di suggerimento, il messaggio e il tipo di icona dei suggerimenti, nonché personalizzare le colonne di una tabella.

La scheda File ti consente di gestire le immagini e i file allegati che carichi sul sito. I collegamenti di pagina ti consentono di creare collegamenti di grandi dimensioni che gli utenti possono facilmente individuare.

Se stai creando documentazione relativa alla lingua Go, puoi utilizzare Godoc. Godoc ti consente di documentare automaticamente il tuo codice Go.