„GitBook“ yra platforma, leidžianti kurti dokumentų svetaines ar įmonės wiki. Galite naudoti jį norėdami dokumentuoti įvairius dalykus, nuo kodo iki API ir kaip naudoti programinės įrangos produktą.
„GitBook“ naudoja panašų procesą kaip „GitHub“ saugyklos. Pagrindinė dokumentacijos kopija veikia kaip „pagrindinė“ kopija. Tada galite sukurti „juodraščius“, kurie yra panašūs į „šakas“.
Šis procesas leidžia daugeliui vartotojų dirbti vienoje dokumentacijos svetainėje, tvarkydami arba užkertant kelią konfliktams. Be to, prieš sujungiant skirtingų šakų pakeitimus, jie gali būti peržiūrimi.
Kaip pradėti naudotis „GitBook“.
Galite rinktis iš kelių GitBook kainodara planus. Kainos priklausys nuo to, ar „GitBook“ naudojate atvirojo kodo projektams, asmeniniam naudojimui ar privačiam komandos bendradarbiavimui. „GitBook“ galima nemokamai naudoti, jei naudojate jį atvirojo kodo projektams.
GitBook palaiko Markdown, populiari žymėjimo kalba, turinti daug privalumų rašyti ar dokumentuoti žiniatinklyje.
GitBook taip pat integruojamas su
GitHub – kodo prieglobos, saugojimo ir redagavimo platforma. Galite susieti savo „GitBook“ paskyrą tiesiogiai su „GitHub“ paskyra prisijungę naudodami „GitHub“ kredencialus.- Prisiregistruokite prie „GitBook“. Jei turite savo GitHub paskyrą, galite spustelėti Prisiregistruokite naudodami „GitHub“..
- Kai prisijungsite, „GitBook“ nukreips jus į naują vidinį wiki. Ji taip pat iš anksto užpildys jūsų wiki pavyzdiniu turiniu.
„GitBook“ sąsajos apžvalga
„GitBook“ turi keletą funkcijų, leidžiančių kurti ir keisti dokumentacijos svetainę.
- Viršutiniame skydelyje galite kurti naujus juodraščius, peržiūrėti pakeitimų istoriją arba peržiūrėti bet kokias kitas diskusijas ar priedus.
- Kairėje pusėje esanti šoninė juosta leidžia sukurti kelias erdves. Skirtingiems projektams galite naudoti atskiras erdves, kad galėtumėte atskirti ir tvarkyti dokumentacijos sritis. Galite išplėsti arba uždaryti šoninę juostą.
- Kairysis skydelis veikia kaip dokumentacijos svetainės meniu. Galite peržiūrėti savo dokumentų svetainės puslapius ir naudoti juos kurdami grupes ir įdėtus puslapius. Taip pat galite naršyti svetainėje naudodami pateiktas nuorodas.
- Apatiniame skydelyje yra mygtukai, kurie yra gyvybiškai svarbūs versijos valdymo procesui. Galite pridėti juodraščio pavadinimą, sujungti pakeitimą arba pateikti pakeitimą peržiūrėti.
Kaip sukurti naują juodraštį
Galite sukurti naują juodraštį sukurdami naują pakeitimų užklausą ir atlikdami joje pakeitimus.
- Viršutiniame skydelyje spustelėkite Prašymai pakeisti.
- Naujame skydelyje, kuris pasirodo dešinėje, spustelėkite Juodraštis skirtuką. Bus rodomi visi aktyvūs juodraščiai.
- Čia galite spustelėti esamą juodraštį, kad jį atidarytumėte. Norėdami sukurti naują juodraštį, spustelėkite Naujas pakeitimo prašymasir palaukite, kol puslapis bus baigtas įkelti.
- Apatiniame skydelyje spustelėkite Įveskite temą. Bus atidarytas langas, kuriame galėsite pavadinti naują juodraštį. Pavyzdžiui, Naujas puslapis – kaip nustatyti kodų bazę.
Kaip sukurti puslapius ir grupes
Kai turėsite juodraštį, galėsite pradėti keisti dokumentaciją. „GitBook“ išsaugo jūsų pakeitimus juodraštyje, todėl jie neturi įtakos pagrindinei kopijai. Norėdami pridėti puslapių ir puslapių grupių, galite naudoti kairiąją šoninę juostą.
- Sukurkite naują puslapį spustelėdami Naujas puslapis nuorodą šoninės juostos apačioje ir pasirinkite Naujas dokumento puslapis iš išskleidžiamojo meniu. Arba galite užvesti pelės žymeklį po esamu puslapiu ir spustelėti mėlyną pliusas mygtuką.
- Norėdami sukurti naują puslapių grupę, spustelėkite Naujas puslapisir pasirinkite Nauja grupė parinktį iš išskleidžiamojo meniu.
- Galite pervardyti puslapį spustelėdami tris taškus šalia puslapio ar grupės ir pasirinkę Pervardyti.
- Pradėkite pridėti turinį, kad užpildytumėte naują puslapį. Galite pridėti paprastą turinį, pvz., tekstą ar antraštes. „GitBook“ taip pat leidžia pridėti kitų turinio blokų, pvz., vaizdų, failų priedų, lentelių, skirtukų ar kodo fragmentų. Taip pat yra galimybė pridėti kitų integracijų, pvz., „YouTube“ įterpimų arba „Google“ dokumentų turinio.
- Spustelėkite ant Skirtingas vaizdas mygtuką apatiniame skydelyje, kad pamatytumėte juodraščio ir originalios pagrindinės dokumentacijos kopijos skirtumus.
- Baigę rašyti turinį, galite spustelėti Sujungti, Pateikti ir sujungti, arba Pateikti peržiūrai.
Bendrinimo nuorodą galite pasiekti viršutiniame „GitBook“ skydelyje. Kad galėtumėte peržiūrėti nuorodą, turėsite nenaudoti juodraščio ir peržiūrėti pagrindinę dokumentacijos kopiją.
- Pagal numatytuosius nustatymus jūsų dokumentų svetainės matomumas yra „neįtrauktas į sąrašą“. Tai reiškia, kad dokumentacijos svetainę galite pasiekti naudodami privačią nuorodą, o ne per paieškos variklius. Viršutiniame skydelyje spustelėkite Neįtraukta į sąrašą mygtuką.
- Išskleidžiamajame meniu pasirinkite norimus matomumo nustatymus. Atminkite, kad „GitBook“ gali užrakinti tam tikrus matomumo nustatymus ir jums gali tekti atnaujinti, kad galėtumėte juos pasiekti.
- Po matomumo nustatymų sąrašu yra nuoroda, kurią galite bendrinti su kitais naudotojais, kurie naudosis jūsų dokumentų svetaine. Nukopijuokite šią nuorodą ir bendrinkite ją su kitais.
- Po nuoroda spustelėkite Nuorodos ir domeno nustatymai. Čia galite susieti tinkintą domeno pavadinimą arba pakeisti dalį URL. Jei naudojate tinkintą domeną, galite peržiūrėti Gitbook dokumentacija kaip teisingai sukonfigūruoti DNS.
Dokumentacijos kūrimas naudojant „GitBook“.
„GitBook“ leidžia bendradarbiaujant kurti ir dirbti su dokumentacijos svetainėmis arba įmonės wiki. „GitBook“ iš „GitHub“ skolinasi tokias koncepcijas kaip filialai ir sujungimas, kad būtų galima valdyti pagrindinę kopiją ir valdyti bet kokius konfliktus.
Galite sukurti naują juodraštį, kad į dokumentaciją įtrauktumėte savo individualius pakeitimus. Juodraštyje galite keisti turinį, taip pat pridėti naujų puslapių ar puslapių grupių. Baigę atlikti pakeitimus galite juos sujungti arba pateikti peržiūrėti.
Jei kuriate vidinius Java kodo dokumentus, galbūt norėsite ištirti Javadoc. „Javadoc“ leidžia automatiškai dokumentuoti „Java“ kodą.
