„GitBook“ yra platforma, leidžianti jums ir jūsų komandai kurti dokumentų svetaines ir bendradarbiauti jose. „GitBook“ tai daro naudodama versijų valdymo koncepcijas, tokias kaip šakojimas ir sujungimas.
Kadangi daugelis komandos narių gali dirbti vienoje dokumentacijos svetainėje, „GitBook“ leidžia kurti ir valdyti atskirus juodraščius. Taip pat galite peržiūrėti dabartinio juodraščio ir pagrindinės dokumentacijos kopijos skirtumus.
Yra keletas blokų tipų, kuriuos galite pridėti prie savo wiki puslapių. Tai apima antraštes, pastraipas, vaizdus, užuominas, lenteles, kodų blokus, failų priedus ir kt.
Kaip pridėti turinio blokus „GitBook“.
Galite peržiūrėti galimų turinio blokų, kuriuos norite įtraukti į puslapį, sąrašą. Tai galite padaryti spustelėdami bet kurią puslapio vietą ir spustelėdami pliusas pasirodo simbolis. Taip pat galite tiesiogiai ieškoti konkretaus turinio bloko.
Galite pridėti turinį naudodami Markdown. Jei anksčiau nenaudojote Markdown, galite sužinoti daugiau apie kaip pradėti naudotis Markdown
. Taip pat galite paskaityti daugiau apie kodėl Markdown yra toks populiarus.Kaip pridėti pastraipų, sąrašų, citatų ar kodų blokų
Norėdami pridėti sąrašų, pastraipų, citatų, kodų blokų ar kitų paprastų turinio blokų, atidarykite išskleidžiamąjį meniu ir pasirinkite iš galimų tipų.
- Dokumentacijos svetainės puslapyje spustelėkite pliusas mygtuką toje vietoje, kur norite pridėti savo turinį.
- Išskleidžiamajame meniu galite slinkti sąrašu ir peržiūrėti įvairias turinio parinktis.
- Iš čia pasirinkite bet kokį paprastą turinio tipą, pvz., pastraipą, kodo bloką, antraštę arba citatą. „GitBook“ automatiškai pakeis turinį, kad atitiktų jūsų pasirinktą formatą.
Kaip pridėti paveikslėlių ar failų priedų
Norėdami pridėti vaizdų, naudokite išskleidžiamąjį meniu, kad pasirinktumėte Vaizdai turinio bloko parinktis. Norėdami pridėti failų, pasirinkite Įterpti failus vietoj to variantas. Tada galite naudoti dešinįjį skydelį, kad galėtumėte tvarkyti įkeltus vaizdus ir failus.
- Atidarykite puslapį savo dokumentų svetainėje. Spustelėkite ant pliusas mygtuką, kad atidarytumėte galimo turinio blokų išskleidžiamąjį meniu.
- Pasirinkite Įterpti vaizdus.
- Pasirodžiusiame dešiniajame skydelyje yra trys skirtukai. The Failai skirtukas leidžia įkelti savo vaizdo failą. The URL skirtuke galite susieti paveikslėlį internete. Taip pat galite atidaryti Atskleiskite purslą skirtuką. Čia galite pasirinkti esamas nuotraukas, kurioms nereikia priskirti.
- Kai pridėsite vaizdą, spustelėkite trys taškai mygtuką, esantį viršutiniame kairiajame vaizdo kampe. Bus atidarytas išskleidžiamasis meniu, kuriame galėsite lygiuoti vaizdą arba jį ištrinti. Taip pat vaizdui galite suteikti antraštę.
- Norėdami įterpti failus, užveskite žymeklį bet kurioje dokumentacijos svetainės puslapio vietoje. Spustelėkite ant pliusas mygtuką, kad atidarytumėte turinio blokų tipų išskleidžiamąjį meniu. Šį kartą spustelėkite įterpti failus variantas.
- Pasirodys panašus dešinysis skydelis, kuriame galėsite įkelti bet kokį failo priedą, o ne vaizdą. Spustelėkite Naršyti failus norėdami pasirinkti failą, saugomą jūsų kompiuteryje.
- Failas bus rodomas sąraše. Spustelėkite failą ir „GitBook“ atidarytame puslapyje sukurs turinio bloką su failo priedu. Spustelėjus šį turinio bloką atsisiunčiamas failo priedas.
Kaip pridėti patarimų
Taip pat galite pridėti patarimų į savo puslapį. Galite pakeisti užuominų piktogramą, kad pavojaus atveju būtų naudojama raudona spalva, perspėjimui – oranžinė, informacijai – mėlyna arba sėkminga žalia spalva.
- Norėdami pridėti užuominą, spustelėkite pliusas mygtuką, kad atidarytumėte galimo turinio blokų išskleidžiamąjį meniu.
- Pasirinkite Užuomina.
- Tai pridės jūsų puslapio užuominą. Pagal numatytuosius nustatymus užuominos tipas yra „informacija“ ir yra mėlyna piktograma.
- Užuominos tipą galite pakeisti spustelėję piktogramą. Tai apims keturis skirtingus užuominų tipus.
Kaip pridėti lenteles
Galite pridėti lenteles pasirinkę stalo parinktį iš išskleidžiamojo sąrašo. Kai turėsite lentelę puslapyje, galite pridėti naujų eilučių arba stulpelių. Taip pat galite keisti stulpelių pavadinimus ir duomenų tipus bei keisti duomenis lentelėje.
- Spustelėkite ant pliusas mygtuką, kad atidarytumėte galimo turinio blokų išskleidžiamąjį meniu.
- Pasirinkite Lentelė.
- Spustelėkite lentelės stulpelio antraštę. Taip atsidarys naujas mažesnis meniu, kuriame galėsite pakeisti pasirinkto stulpelio pavadinimą. Šis meniu taip pat leidžia ištrinti arba paslėpti pasirinktą stulpelį. Tam tikrų tipų stulpelių duomenų turinį taip pat galite lygiuoti stulpelio viduje.
- Pagal numatytuosius nustatymus pasirinktas stulpelių duomenų tipas yra „Tekstas“. Spustelėkite mygtuką su T simbolį, kad pakeistumėte duomenų tipą. Galite pakeisti jį į skaičių, žymimąjį laukelį, išskleidžiamąjį meniu, failo priedą, įvertinimą ar kt.
- Spustelėkite ant šešių taškų piktograma šalia viršutinio kairiojo stalo kampo. Čia galite įterpti naujus stulpelius ir eilutes arba ištrinti visą lentelę. Taip pat galite paslėpti arba rodyti tam tikrus stulpelius arba pakeisti kitas lentelės ypatybes.
Kaip pridėti puslapio nuorodų blokus
Puslapio nuorodų blokai yra nuorodos, kurios užima visą puslapio eilutę. Kai pridedate nuorodą, turite susieti puslapį, kuris atsidarys, kai kas nors jį spustelėja.
- Spustelėkite ant pliusas mygtuką, kad atidarytumėte galimo turinio blokų išskleidžiamąjį meniu.
- Spustelėkite Puslapio nuoroda.
- Naujame išskleidžiamajame meniu pasirinkite puslapį, į kurį nukreipiate.
- Jūsų puslapio nuoroda bus rodoma puslapio bloke.
„GitBook“ naudojimas dokumentavimui
„GitBook“ yra dokumentavimo įrankis, kuriame naudojamos versijų valdymo sąvokos, tokios kaip šakojimas ir sujungimas. Tai leidžia daugiau nei vienam komandos nariui vienu metu dirbti su dokumentacija. Tai taip pat padeda valdyti kilusius konfliktus.
Puslapyje galite pridėti visų rūšių turinio blokų. Turiniui performatuoti galite naudoti antraštes, pastraipas, kodų blokus arba ženklelius. Galite pakeisti užuominų tipą, pranešimą ir užuominų piktogramos tipą, taip pat tinkinti lentelės stulpelius.
Skirtuke Failai galite tvarkyti vaizdus ir failų priedus, kuriuos įkeliate į svetainę. Puslapių nuorodos leidžia kurti dideles nuorodas, kurias vartotojai gali lengvai pastebėti.
Jei kuriate dokumentaciją, susijusią su Go kalba, galite naudoti Godoc. „Godoc“ leidžia automatiškai dokumentuoti „Go“ kodą.
