GitBook este o platformă care vă permite dvs. și echipei dvs. să creați și să colaborați pe site-uri de documentare. GitBook face acest lucru folosind concepte de control al versiunilor, cum ar fi ramificarea și îmbinarea.
Deoarece mulți membri ai echipei pot lucra pe un singur site de documentare, GitBook vă permite să creați și să gestionați schițe separate. De asemenea, puteți vedea diferențele dintre schița actuală și copia documentației principale.
Mai multe tipuri de blocuri sunt disponibile pentru a le adăuga la paginile tale wiki. Acestea includ titluri, paragrafe, imagini, sugestii, tabele, blocuri de cod, atașamente de fișiere și multe altele.
Cum să adăugați blocuri de conținut în GitBook
Puteți vizualiza o listă a blocurilor de conținut disponibile pentru a le adăuga la o pagină. Puteți face acest lucru făcând clic oriunde pe pagină și făcând clic pe la care se adauga simbol care apare. De asemenea, puteți căuta direct un anumit bloc de conținut.
Puteți adăuga conținut folosind Markdown. Dacă nu ați folosit Markdown înainte, puteți afla mai multe despre
cum să începeți cu Markdown. De asemenea, puteți citi mai multe despre de ce Markdown este atât de popular.Cum să adăugați paragrafe, liste, citate sau blocuri de cod
Pentru a adăuga liste, paragrafe, citate, blocuri de cod sau alte blocuri de conținut simple, deschideți meniul derulant și selectați dintre tipurile disponibile.
- Pe o pagină din site-ul dvs. de documentare, faceți clic pe la care se adauga butonul din locația în care doriți să adăugați conținutul dvs.
- Din meniul drop-down, puteți derula prin listă pentru a vedea diferitele opțiuni de conținut.
- De aici, selectați orice tip de conținut simplu, cum ar fi un paragraf, un bloc de cod, un titlu sau un citat. GitBook va schimba automat conținutul pentru a se potrivi cu formatul pe care l-ați selectat.
Cum să adăugați imagini sau fișiere atașate
Pentru a adăuga imagini, utilizați meniul drop-down pentru a selecta Imagini opțiunea de blocare a conținutului. Pentru a adăuga fișiere, selectați Inserați fișiere opțiune în schimb. Puteți utiliza apoi panoul din dreapta pentru a gestiona imaginile și fișierele încărcate.
- Deschideți o pagină pe site-ul dvs. de documentare. Faceți clic pe la care se adauga pentru a deschide meniul derulant pentru blocurile de conținut disponibile.
- Selectați Inserați imagini.
- În panoul din dreapta care apare, există trei file. The Fișiere fila vă permite să încărcați propriul fișier imagine. The URL fila vă permite să conectați la o imagine online. De asemenea, puteți deschide Unsplash fila. Aici puteți selecta fotografiile existente care nu necesită atribuire.
- După ce ați adăugat o imagine, faceți clic pe trei puncte butonul situat în colțul din stânga sus al imaginii. Aceasta va deschide un meniu derulant unde puteți alinia imaginea sau o puteți șterge. De asemenea, puteți da imaginii o legendă.
- Pentru a insera fișiere, plasați cursorul oriunde pe o pagină de pe site-ul de documentare. Faceți clic pe la care se adauga butonul pentru a deschide meniul drop-down tipuri de blocuri de conținut. De data aceasta, faceți clic pe inserați fișiere opțiune.
- Va apărea un panou similar din partea dreaptă, permițându-vă să încărcați orice fișier atașat în loc de o imagine. Click pe Cauta fisiere pentru a selecta un fișier stocat local pe computer.
- Fișierul va apărea pe listă. Faceți clic pe fișier și GitBook va crea un bloc de conținut cu fișierul atașat pe pagina pe care ați deschis-o. Făcând clic pe acest bloc de conținut, se va descărca fișierul atașat.
Cum să adăugați indicii
De asemenea, puteți adăuga indicii la pagina dvs. Puteți schimba pictograma pentru indicii pentru a utiliza roșu pentru pericol, portocaliu pentru avertizare, albastru pentru informații sau verde pentru succes.
- Pentru a adăuga un indiciu, faceți clic pe la care se adauga pentru a deschide meniul derulant pentru blocurile de conținut disponibile.
- Selectați Aluzie.
- Acest lucru va adăuga un indiciu la pagina dvs. În mod implicit, tipul de indiciu este „informații” și conține o pictogramă albastră.
- Puteți schimba tipul de indiciu făcând clic pe pictogramă. Acest lucru va trece prin cele patru tipuri diferite de indicii.
Cum se adaugă tabele
Puteți adăuga tabele selectând masa opțiunea din lista verticală. Odată ce aveți tabelul pe pagină, puteți adăuga noi rânduri sau coloane. De asemenea, puteți modifica numele și tipurile de date ale coloanelor și puteți modifica datele din tabel.
- Faceți clic pe la care se adauga pentru a deschide meniul derulant pentru blocurile de conținut disponibile.
- Selectați Masa.
- Faceți clic pe antetul unei coloane din tabel. Aceasta va deschide un nou meniu mai mic, unde puteți schimba numele coloanei selectate. Acest meniu vă permite, de asemenea, să ștergeți sau să ascundeți coloana selectată. Pentru anumite tipuri de date de coloană, puteți, de asemenea, să aliniați conținutul în interiorul coloanei.
- În mod implicit, tipul de date selectat pentru coloane este „Text”. Faceți clic pe butonul cu T simbol pentru a schimba tipul de date. Îl puteți schimba într-un număr, casetă de selectare, meniu drop-down, fișier atașat, evaluare sau mai mult.
- Faceți clic pe pictograma șase puncte lângă colțul din stânga sus al mesei. Aici puteți introduce coloane și rânduri noi sau puteți șterge întregul tabel. De asemenea, puteți ascunde sau afișa anumite coloane sau puteți modifica alte proprietăți pentru tabel.
Cum să adăugați blocuri de link-uri la pagină
Blocurile de linkuri de pagină sunt link-uri care ocupă întreaga linie a paginii. Când adăugați linkul, trebuie să faceți un link către pagina care se va deschide când cineva face clic pe ea.
- Faceți clic pe la care se adauga pentru a deschide meniul derulant pentru blocurile de conținut disponibile.
- Click pe link-ul paginii.
- Din noul meniu derulant, alegeți pagina la care vă conectați.
- Link-ul paginii dvs. va apărea într-un bloc pe pagină.
Folosind GitBook pentru documentare
GitBook este un instrument de documentare care utilizează concepte de control al versiunilor, cum ar fi ramificarea și îmbinarea. Acest lucru permite mai multor membri ai echipei să lucreze simultan la documentație. De asemenea, ajută la gestionarea oricăror conflicte care apar.
Puteți adăuga tot felul de blocuri de conținut la o pagină. Puteți folosi titluri, paragrafe, blocuri de cod sau marcatori pentru a vă reforma conținutul. Puteți modifica tipul de indiciu, mesajul și tipul de pictogramă al indicațiilor, precum și să personalizați coloanele unui tabel.
Fila Fișiere vă permite să gestionați imaginile și fișierele atașate pe care le încărcați pe site. Link-urile paginilor vă permit să creați legături mari pe care utilizatorii le pot identifica cu ușurință.
Dacă creați documentație legată de limba Go, puteți utiliza Godoc. Godoc vă permite să vă documentați automat codul Go.