GitBook je platforma, ki vam omogoča izdelavo spletnih mest z dokumentacijo ali wikijev podjetja. Uporabite ga lahko za dokumentiranje vseh vrst stvari, od kode do API-jev in uporabe programskega izdelka.

GitBook uporablja podoben postopek kot repozitoriji GitHub. Glavna kopija dokumentacije deluje kot "master" kopija. Nato lahko ustvarite "osnutke", ki so podobni "vejam".

Ta postopek omogoča številnim uporabnikom, da delajo na enem mestu z dokumentacijo, medtem ko obravnavajo ali preprečujejo spore. Prav tako omogoča, da gredo spremembe iz različnih vej skozi postopek pregleda, preden jih združite.

Kako začeti uporabljati GitBook

Izbirate lahko med več Cene GitBook načrti. Cene bodo odvisne od tega, ali uporabljate GitBook za odprtokodne projekte, osebno uporabo ali zasebno timsko sodelovanje. GitBook je brezplačen za uporabo, če ga uporabljate za odprtokodne projekte.

GitBook podpira Markdown, priljubljen označevalni jezik s številnimi prednostmi za pisanje ali dokumentiranje na spletu.

GitBook se integrira tudi z

instagram viewer
GitHub, platforma za gostovanje, shranjevanje in urejanje kode. Račun GitBook lahko povežete neposredno z računom GitHub tako, da se prijavite s svojimi poverilnicami GitHub.

  1. Prijavite se v GitBook. Če imate svoj račun GitHub, lahko kliknete Prijavite se z GitHub.
  2. Ko se prijavite, vas bo GitBook preusmeril na nov notranji wiki. Prav tako bo vaš wiki vnaprej napolnil z nekaj vzorčne vsebine.

Pregled vmesnika GitBook

GitBook ima več funkcij, ki vam omogočajo gradnjo in spreminjanje spletnega mesta z dokumentacijo.

  1. Zgornja plošča vam omogoča ustvarjanje novih osnutkov, ogled zgodovine sprememb ali ogled drugih razprav ali prilog.
  2. Skrajno leva stranska vrstica omogoča ustvarjanje več presledkov. Za različne projekte lahko uporabite ločene prostore, tako da lahko ločite in organizirate področja dokumentacije. Stransko vrstico lahko razširite ali zaprete.
  3. Leva plošča deluje kot meni za mesto dokumentacije. Ogledate si lahko strani na svojem dokumentacijskem mestu in ga uporabite za ustvarjanje skupin in ugnezdenih strani. Po spletnem mestu lahko krmarite tudi s pomočjo navedenih povezav.
  4. Spodnja plošča vključuje gumbe, ki so ključni za postopek nadzora različic. Osnutku lahko dodate ime, združite spremembo ali pošljete spremembo v pregled.

Kako ustvariti nov osnutek

Nov osnutek lahko ustvarite tako, da ustvarite novo zahtevo za spremembo in v njej izvedete spremembe.

  1. Na zgornji plošči kliknite na Zahteve za spremembe.
  2. Na novi plošči, ki se prikaže na desni strani, kliknite na Osnutek zavihek. To vam bo pokazalo vse vaše aktivne osnutke.
  3. Tukaj lahko kliknete obstoječi osnutek, da ga odprete. Če želite ustvariti nov osnutek, kliknite na Nova zahteva za sprememboin počakajte, da se stran naloži.
  4. Na spodnji plošči kliknite na Vnesite zadevo. To bo odprlo okno, v katerem lahko poimenujete nov osnutek. npr. Nova stran - Kako nastaviti kodno zbirko.

Kako ustvariti strani in skupine

Ko imate osnutek, lahko začnete spreminjati dokumentacijo. GitBook shrani vaše spremembe znotraj osnutka, tako da ne vplivajo na glavno kopijo. Za dodajanje strani in skupin strani lahko uporabite levo stransko vrstico.

  1. Ustvarite novo stran s klikom na Nova stran povezavo na dnu stranske vrstice in izbiro Nova stran dokumenta iz spustnega menija. Lahko pa se premaknete pod obstoječo stran in kliknete modro plus gumb.
  2. Če želite ustvariti novo skupino strani, kliknite Nova stranin izberite Nova skupina možnost iz spustnega menija.
  3. Stran lahko preimenujete tako, da kliknete tri pike poleg strani ali skupine in izberete Preimenuj.
  4. Začnite dodajati vsebino, da napolnite svojo novo stran. Dodate lahko preprosto vsebino, kot so besedilo ali naslovi. GitBook vam omogoča tudi dodajanje drugih blokov vsebine, kot so slike, datotečne priloge, tabele, zavihki ali izrezki kode. Obstaja tudi možnost dodajanja drugih integracij, kot so vdelave v YouTube ali vsebina Google Dokumentov.
  5. Kliknite na Različni pogled na spodnji plošči, da si ogledate razlike med osnutkom in originalno kopijo glavne dokumentacije.
  6. Ko končate s pisanjem vsebine, lahko kliknete Spoji, Oddaj in združi, oz Oddaj v pregled.

Do povezave za skupno rabo lahko dostopate z zgornje plošče GitBook. Da si boste lahko ogledali povezavo, boste morali biti zunaj osnutka in si ogledovati glavno kopijo dokumentacije.

  1. Vidnost vašega dokumentacijskega mesta je privzeto »nenavedena«. To pomeni, da lahko do spletnega mesta z dokumentacijo dostopate prek zasebne povezave in ne prek iskalnikov. Na zgornji plošči kliknite na Nenaveden gumb.
  2. V spustnem meniju izberite želene nastavitve vidnosti. Upoštevajte, da lahko GitBook zaklene določene nastavitve vidnosti in boste za dostop do njih morda morali nadgraditi.
  3. Pod seznamom nastavitev vidnosti je povezava, ki jo lahko delite z drugimi uporabniki, ki bodo uporabljali vaše mesto z dokumentacijo. Kopirajte to povezavo, da jo delite z drugimi.
  4. Pod povezavo kliknite na Nastavitve povezave in domene. Tukaj lahko povežete ime domene po meri ali spremenite del URL-ja. Če uporabljate domeno po meri, si lahko ogledate Dokumentacija Gitbooka o tem, kako pravilno konfigurirati svoj DNS.

Ustvarjanje dokumentacije z uporabo GitBook

GitBook vam omogoča skupno ustvarjanje in delo na spletnih mestih z dokumentacijo ali wikijih podjetja. GitBook si od GitHuba izposoja koncepte, kot so veje in združevanje, da nadzoruje glavno kopijo in upravlja morebitne konflikte.

Ustvarite lahko nov osnutek, da dodate svoje lastne spremembe v dokumentacijo. Znotraj osnutka lahko spremenite vsebino, pa tudi dodate nove strani ali skupine strani. Ko končate s spremembami, jih lahko združite ali pošljete v pregled.

Če ustvarjate interno dokumentacijo za kodo Java, boste morda želeli raziskati Javadoc. Javadoc vam omogoča samodejno dokumentiranje kode Java.