GitBook je platforma, ki vam in vaši ekipi omogoča ustvarjanje in sodelovanje na spletnih mestih z dokumentacijo. GitBook to počne z uporabo konceptov nadzora različic, kot sta razvejanje in združevanje.
Ker lahko veliko članov ekipe dela na enem mestu z dokumentacijo, GitBook omogoča ustvarjanje in upravljanje ločenih osnutkov. Ogledate si lahko tudi razlike med trenutnim osnutkom in kopijo glavne dokumentacije.
Na voljo je več vrst blokov, ki jih lahko dodate svojim wiki stranem. To vključuje naslove, odstavke, slike, namige, tabele, kodne bloke, datotečne priloge in drugo.
Kako dodati bloke vsebine v GitBook
Ogledate si lahko seznam razpoložljivih blokov vsebine, ki jih želite dodati na stran. To lahko storite tako, da kliknete kjer koli na strani in kliknete na plus simbol, ki se pojavi. Prav tako lahko neposredno iščete določen blok vsebine.
Vsebino lahko dodate z uporabo Markdown. Če Markdown še niste uporabljali, lahko izveste več o kako začeti uporabljati Markdown. Preberete lahko tudi več o zakaj je Markdown tako priljubljen.
Kako dodati odstavke, sezname, citate ali bloke kode
Če želite dodati sezname, odstavke, narekovaje, bloke kode ali druge preproste bloke vsebine, odprite spustni meni in izberite med vrstami, ki so na voljo.
- Na strani v dokumentacijskem mestu kliknite na plus gumb na mestu, kamor želite dodati svojo vsebino.
- V spustnem meniju se lahko pomikate po seznamu in si ogledate različne možnosti vsebine.
- Tukaj izberite katero koli preprosto vrsto vsebine, kot je odstavek, blok kode, naslov ali citat. GitBook bo samodejno spremenil vsebino, da bo ustrezala formatu, ki ste ga izbrali.
Kako dodati slike ali datotečne priloge
Če želite dodati slike, uporabite spustni meni, da izberete Slike možnost blokiranja vsebine. Če želite dodati datoteke, izberite Vstavi datoteke možnost namesto tega. Nato lahko uporabite desno ploščo za upravljanje naloženih slik in datotek.
- Odprite stran na svojem dokumentacijskem mestu. Kliknite na plus gumb za odpiranje spustnega menija za bloke vsebine, ki so na voljo.
- Izberite Vstavi slike.
- Na desni plošči, ki se prikaže, so trije zavihki. The Datoteke zavihek omogoča nalaganje lastne slikovne datoteke. The URL zavihek omogoča povezavo do slike na spletu. Odprete lahko tudi Unsplash zavihek. Tukaj lahko izberete obstoječe fotografije, ki ne zahtevajo pripisa.
- Ko dodate sliko, kliknite na tri pike gumb, ki se nahaja v zgornjem levem kotu slike. To bo odprlo spustni meni, kjer lahko poravnate sliko ali jo izbrišete. Sliki lahko dodate tudi napis.
- Če želite vstaviti datoteke, postavite kazalec kamor koli na stran na mestu z dokumentacijo. Kliknite na plus gumb za odpiranje spustnega menija za vrste blokov vsebine. Tokrat kliknite na vstavite datoteke možnost.
- Pojavila se bo podobna desna plošča, ki vam bo omogočila nalaganje katere koli datotečne priloge namesto slike. Kliknite na Brskanje po datotekah da izberete datoteko, shranjeno lokalno v vašem računalniku.
- Datoteka se prikaže na seznamu. Kliknite na datoteko in GitBook bo ustvaril blok vsebine s priponko datoteke na strani, ki ste jo odprli. S klikom na ta blok vsebine se prenese priponka datoteke.
Kako dodati namige
Svoji strani lahko dodate tudi namige. Ikono za namige lahko spremenite tako, da bo rdeča za nevarnost, oranžna za opozorilo, modra za informacije ali zelena za uspeh.
- Če želite dodati namig, kliknite na plus gumb za odpiranje spustnega menija za bloke vsebine, ki so na voljo.
- Izberite Namig.
- To bo vaši strani dodalo namig. Privzeto je vrsta namigovanja "informacija" in vsebuje modro ikono.
- Vrsto namiga lahko spremenite s klikom na ikono. To bo prešlo skozi štiri različne vrste namigov.
Kako dodati tabele
Tabele lahko dodate tako, da izberete tabela možnost s spustnega seznama. Ko imate tabelo na strani, lahko dodate nove vrstice ali stolpce. Spremenite lahko tudi imena in vrste podatkov stolpcev ter spremenite podatke v tabeli.
- Kliknite na plus gumb za odpiranje spustnega menija za bloke vsebine, ki so na voljo.
- Izberite Tabela.
- Kliknite na glavo stolpca v tabeli. S tem se odpre nov manjši meni, kjer lahko spremenite ime izbranega stolpca. Ta meni omogoča tudi brisanje ali skrivanje izbranega stolpca. Za določene podatkovne vrste stolpcev lahko poravnate tudi vsebino znotraj stolpca.
- Privzeto je izbrana vrsta podatkov za stolpce »Besedilo«. Kliknite na gumb z T simbol za spremembo vrste podatkov. Lahko ga spremenite v številko, potrditveno polje, spustni meni, datotečno prilogo, oceno ali drugo.
- Kliknite na ikona šestih pik blizu zgornjega levega kota tabele. Tukaj lahko vstavite nove stolpce in vrstice ali izbrišete celotno tabelo. Določene stolpce lahko tudi skrijete ali prikažete ali spremenite druge lastnosti tabele.
Kako dodati bloke povezav strani
Bloki povezav strani so povezave, ki zavzamejo celotno vrstico na strani. Ko dodate povezavo, se morate povezati s stranjo, ki se bo odprla, ko jo nekdo klikne.
- Kliknite na plus gumb za odpiranje spustnega menija za bloke vsebine, ki so na voljo.
- Kliknite na Povezava do strani.
- V novem spustnem meniju izberite stran, na katero se povezujete.
- Povezava do vaše strani se bo pojavila znotraj bloka na strani.
Uporaba GitBooka za dokumentacijo
GitBook je dokumentacijsko orodje, ki uporablja koncepte nadzora različic, kot sta razvejanje in združevanje. To omogoča več kot enemu članu ekipe, da hkrati dela na dokumentaciji. Pomaga tudi pri obvladovanju morebitnih konfliktov, ki se pojavijo.
Na stran lahko dodate vse vrste blokov vsebine. Za preoblikovanje vsebine lahko uporabite naslove, odstavke, bloke kode ali oznake. Spremenite lahko vrsto namiga, sporočilo in vrsto ikone namigov ter prilagodite stolpce tabele.
Zavihek Datoteke vam omogoča upravljanje slik in datotečnih prilog, ki jih naložite na spletno mesto. Povezave strani vam omogočajo ustvarjanje velikih povezav, ki jih uporabniki zlahka opazijo.
Če ustvarjate dokumentacijo, povezano z jezikom Go, lahko uporabite Godoc. Godoc vam omogoča samodejno dokumentiranje kode Go.
