GitBook je platforma koja vama i vašem timu omogućuje stvaranje i suradnju na stranicama s dokumentacijom. GitBook to čini koristeći koncepte kontrole verzija, kao što su grananje i spajanje.
Budući da mnogi članovi tima mogu raditi na jednom dokumentacijskom mjestu, GitBook vam omogućuje stvaranje zasebnih nacrta i upravljanje njima. Također možete vidjeti razlike između vašeg trenutnog nacrta i kopije glavne dokumentacije.
Dostupno je nekoliko vrsta blokova koje možete dodati na svoje wiki stranice. To uključuje naslove, odlomke, slike, savjete, tablice, blokove koda, privitke datoteka i još mnogo toga.
Kako dodati blokove sadržaja u GitBook
Možete vidjeti popis dostupnih blokova sadržaja za dodavanje na stranicu. To možete učiniti tako da kliknete bilo gdje na stranici i kliknete na plus simbol koji se pojavljuje. Također možete izravno tražiti određeni blok sadržaja.
Sadržaj možete dodavati pomoću Markdowna. Ako dosad niste koristili Markdown, možete saznati više o kako započeti s Markdownom. Također možete pročitati više o zašto je Markdown toliko popularan.
Kako dodati odlomke, popise, citate ili blokove koda
Za dodavanje popisa, odlomaka, citata, blokova koda ili drugih blokova jednostavnog sadržaja otvorite padajući izbornik i odaberite jednu od dostupnih vrsta.
- Na stranici na web-mjestu s dokumentacijom kliknite na plus gumb na mjestu gdje želite dodati svoj sadržaj.
- S padajućeg izbornika možete se kretati kroz popis da biste vidjeli različite opcije sadržaja.
- Odavde odaberite bilo koju jednostavnu vrstu sadržaja, poput odlomka, bloka koda, naslova ili citata. GitBook će automatski promijeniti sadržaj kako bi odgovarao formatu koji ste odabrali.
Kako dodati slike ili privitke datoteka
Za dodavanje slika koristite padajući izbornik za odabir Slike opcija blokiranja sadržaja. Za dodavanje datoteka odaberite Umetanje datoteka umjesto toga. Zatim možete koristiti desnu ploču za upravljanje prenesenim slikama i datotekama.
- Otvorite stranicu na svom mjestu s dokumentacijom. Klikni na plus gumb za otvaranje padajućeg izbornika za dostupne blokove sadržaja.
- Odaberi Umetanje slika.
- Na desnoj ploči koja se pojavi nalaze se tri kartice. The Datoteke kartica vam omogućuje učitavanje vlastite slikovne datoteke. The URL kartica omogućuje povezivanje na sliku na mreži. Također možete otvoriti Unsplash tab. Ovdje možete odabrati postojeće fotografije koje ne zahtijevaju atribuciju.
- Nakon što ste dodali sliku, kliknite na tri točkice gumb koji se nalazi u gornjem lijevom kutu slike. Ovo će otvoriti padajući izbornik na kojem možete poravnati sliku ili je izbrisati. Slici također možete dodati naslov.
- Da biste umetnuli datoteke, postavite pokazivač bilo gdje na stranicu na web-mjestu s dokumentacijom. Klikni na plus gumb za otvaranje padajućeg izbornika s vrstama blokova sadržaja. Ovaj put kliknite na umetnite datoteke opcija.
- Pojavit će se slična desna ploča koja vam omogućuje učitavanje bilo kojeg privitka datoteke umjesto slike. Kliknite na Pregledajte datoteke za odabir datoteke pohranjene lokalno na vašem računalu.
- Datoteka će se pojaviti na popisu. Kliknite na datoteku i GitBook će stvoriti blok sadržaja s privitkom datoteke na stranici koju ste otvorili. Klikom na ovaj blok sadržaja preuzima se privitak datoteke.
Kako dodati savjete
Također možete dodati savjete na svoju stranicu. Možete promijeniti ikonu za savjete tako da koristi crvenu za opasnost, narančastu za upozorenje, plavu za informacije ili zelenu za uspjeh.
- Da biste dodali savjet, kliknite na plus gumb za otvaranje padajućeg izbornika za dostupne blokove sadržaja.
- Odaberi Savjet.
- Ovo će vašoj stranici dodati savjet. Prema zadanim postavkama, tip savjeta je "informacija" i sadrži plavu ikonu.
- Tip savjeta možete promijeniti klikom na ikonu. Ovo će proći kroz četiri različite vrste savjeta.
Kako dodati tablice
Možete dodati tablice odabirom stol opciju s padajućeg popisa. Nakon što imate tablicu na stranici, možete dodati nove retke ili stupce. Također možete izmijeniti nazive i vrste podataka stupaca te promijeniti podatke unutar tablice.
- Klikni na plus gumb za otvaranje padajućeg izbornika za dostupne blokove sadržaja.
- Odaberi Stol.
- Kliknite na zaglavlje stupca u tablici. Ovo će otvoriti novi manji izbornik, gdje možete promijeniti naziv odabranog stupca. Ovaj vam izbornik također omogućuje brisanje ili skrivanje odabranog stupca. Za određene vrste podataka stupaca možete također poravnati sadržaj unutar stupca.
- Prema zadanim postavkama odabrana vrsta podataka za stupce je "Tekst". Kliknite na gumb s T simbol za promjenu vrste podataka. Možete ga promijeniti u broj, potvrdni okvir, padajući izbornik, privitak datoteke, ocjenu ili više.
- Klikni na ikona sa šest točaka blizu gornjeg lijevog kuta stola. Ovdje možete umetnuti nove stupce i retke ili izbrisati cijelu tablicu. Također možete sakriti ili prikazati određene stupce ili promijeniti druga svojstva tablice.
Kako dodati blokove veza stranice
Blokovi veza stranice su veze koje zauzimaju cijeli red na stranici. Kada dodate poveznicu, morate se povezati na stranicu koja će se otvoriti kada netko klikne na nju.
- Klikni na plus gumb za otvaranje padajućeg izbornika za dostupne blokove sadržaja.
- Kliknite na Veza na stranicu.
- S novog padajućeg izbornika odaberite stranicu na koju se povezujete.
- Veza na vašu stranicu pojavit će se unutar bloka na stranici.
Korištenje GitBooka za dokumentaciju
GitBook je dokumentacijski alat koji koristi koncepte kontrole verzija kao što su grananje i spajanje. To omogućuje da više od jednog člana tima istovremeno radi na dokumentaciji. Također pomaže u upravljanju svim sukobima koji se dogode.
Na stranicu možete dodati sve vrste blokova sadržaja. Možete koristiti naslove, odlomke, blokove koda ili grafičke oznake za preoblikovanje sadržaja. Možete promijeniti vrstu savjeta, poruku i vrstu ikona savjeta, kao i prilagoditi stupce tablice.
Kartica Datoteke omogućuje vam upravljanje slikama i privicima datoteka koje učitate na stranicu. Veze na stranice omogućuju vam stvaranje velikih veza koje korisnici mogu lako uočiti.
Ako izrađujete dokumentaciju koja se odnosi na Go jezik, možete koristiti Godoc. Godoc vam omogućuje automatsko dokumentiranje vašeg Go koda.