Kako stvoriti jednostavan interni Wiki koristeći Gitbook

Kako stvoriti jednostavan interni Wiki koristeći Gitbook

GitBook je platforma koja vam omogućuje izradu stranica s dokumentacijom ili wikija tvrtke. Možete ga koristiti za dokumentiranje svih vrsta stvari, od koda do API-ja i načina korištenja softverskog proizvoda.





GitBook koristi sličan proces kao GitHub repozitoriji. Glavni primjerak dokumentacije djeluje kao 'glavni' primjerak. Tada možete stvoriti 'skice', koje su slične 'granama'.





kako dodati homebrew na wii

Ovaj proces omogućuje mnogim korisnicima rad na jednom dokumentacijskom mjestu dok rješavaju ili sprječavaju sukobe. Također omogućuje promjenama iz različitih grana da prođu kroz proces pregleda prije nego što ih spojite.





Kako početi koristiti GitBook

Možete birati između nekoliko GitBook cijene planovi. Cijene će ovisiti o tome koristite li GitBook za projekte otvorenog koda, osobnu upotrebu ili privatnu timsku suradnju. GitBook je besplatan za korištenje ako ga koristite za projekte otvorenog koda.

GitBook podržava Markdown, popularan označni jezik s mnogim prednostima za pisanje ili dokumentiranje na webu.



GitBook se također integrira sa GitHub, platforma za hosting, pohranu i uređivanje koda . Možete povezati svoj GitBook račun izravno sa svojim GitHub računom prijavom koristeći svoje GitHub vjerodajnice.

  1. Prijavite se na GitBook. Ako imate vlastiti GitHub račun, možete kliknuti na Prijavite se na GitHub .
  2. Nakon što se prijavite, GitBook će vas preusmjeriti na novi interni wiki. Također će unaprijed popuniti vaš wiki s uzorcima sadržaja.

Pregled GitBook sučelja

GitBook ima nekoliko funkcija koje vam omogućuju da gradite i mijenjate svoju stranicu s dokumentacijom.





  1. Gornja ploča vam omogućuje stvaranje novih nacrta, pregled povijesti promjena ili pregled bilo kojih drugih rasprava ili privitaka.
  2. Krajnja lijeva bočna traka omogućuje stvaranje više prostora. Možete koristiti odvojene prostore za različite projekte tako da možete odvojiti i organizirati svoja područja dokumentacije. Možete proširiti ili zatvoriti bočnu traku.
  3. Lijeva ploča služi kao izbornik za stranicu s dokumentacijom. Možete pregledavati stranice unutar svoje stranice dokumentacije i koristiti je za stvaranje grupa i ugniježđenih stranica. Također se možete kretati web mjestom pomoću ponuđenih veza.
  4. Donja ploča uključuje gumbe koji su vitalni za proces kontrole verzija. Možete dodati naziv za svoju skicu, spojiti promjenu ili poslati promjenu na pregled.

Kako stvoriti novi nacrt

Novu skicu možete izraditi stvaranjem novog Zahtjeva za promjenu i unosom izmjena unutar njega.

  1. Na gornjoj ploči kliknite na Zahtjevi za promjenu .
  2. Na novoj ploči koja se pojavljuje s desne strane kliknite na Nacrt tab. Ovo će vam pokazati sve vaše aktivne skice.
  3. Odavde možete kliknuti postojeću skicu da biste je otvorili. Za izradu novog nacrta kliknite na Novi zahtjev za promjenu i pričekajte da se stranica učita.
  4. Na donjoj ploči kliknite na Unesite predmet . Ovo će otvoriti prozor u kojem možete dati naziv novom nacrtu. Na primjer, Nova stranica - Kako postaviti bazu kodova .

Kako stvoriti stranice i grupe

Nakon što imate nacrt, možete početi mijenjati dokumentaciju. GitBook pohranjuje vaše promjene unutar nacrta, tako da ne utječu na glavnu kopiju. Možete koristiti lijevu bočnu traku za dodavanje stranica i grupa stranica.





  1. Napravite novu stranicu klikom na Nova stranica vezu na dnu bočne trake i odabirom Nova stranica dokumenta s padajućeg izbornika. Alternativno, možete lebdjeti ispod postojeće stranice i kliknuti na plavu plus dugme.
  2. Za stvaranje nove grupe stranica kliknite na Nova stranica i odaberite Nova grupa opciju s padajućeg izbornika.
  3. Stranicu možete preimenovati klikom na tri točkice pored stranice ili grupe i odabirom Preimenovati .
  4. Počnite dodavati sadržaj za popunjavanje svoje nove stranice. Možete dodati jednostavan sadržaj poput teksta ili naslova. GitBook vam također omogućuje dodavanje drugih blokova sadržaja kao što su slike, privici datoteka, tablice, kartice ili isječci koda. Također postoji opcija za dodavanje drugih integracija kao što su YouTube ugradnje ili sadržaj Google dokumenata.
  5. Klikni na Diff pogled gumb na donjoj ploči za prikaz razlika između vašeg nacrta i izvorne kopije glavne dokumentacije.
  6. Nakon što završite s pisanjem sadržaja, možete kliknuti na Sjediniti , Predajte i spojite , ili Pošaljite na pregled .

Možete pristupiti poveznici za dijeljenje s gornje ploče GitBooka. Morat ćete biti izvan nacrta i pregledavati kopiju glavne dokumentacije da biste mogli vidjeti vezu.

  1. Prema zadanim postavkama, vidljivost vaše web stranice s dokumentacijom je 'nenavedena'. To znači da stranici s dokumentacijom možete pristupiti putem privatne veze, a ne putem tražilica. Na gornjoj ploči kliknite na Nenavedeno dugme.
  2. S padajućeg izbornika odaberite željene postavke vidljivosti. Imajte na umu da GitBook može zaključati određene postavke vidljivosti i možda ćete morati nadograditi da biste im pristupili.
  3. Ispod popisa postavki vidljivosti nalazi se poveznica koju možete podijeliti s drugim korisnicima koji će koristiti vašu stranicu s dokumentacijom. Kopirajte ovu vezu da biste je podijelili s drugima.
  4. Ispod poveznice kliknite na Postavke veze i domene . Ovdje možete povezati prilagođeni naziv domene ili izmijeniti dio URL-a. Ako koristite prilagođenu domenu, možete pogledati Gitbookova dokumentacija o tome kako ispravno konfigurirati svoj DNS.

Stvaranje dokumentacije pomoću GitBooka

GitBook vam omogućuje zajedničko stvaranje i rad na stranicama s dokumentacijom ili wikijima tvrtke. GitBook posuđuje koncepte od GitHuba poput grananja i spajanja za kontrolu glavne kopije i upravljanje svim sukobima.

Možete izraditi novi nacrt kako biste dodali vlastite pojedinačne promjene u dokumentaciju. Unutar nacrta možete mijenjati sadržaj, kao i dodavati nove stranice ili grupe stranica. Nakon što završite s izmjenama, možete ih spojiti ili poslati na pregled.

Ako stvarate internu dokumentaciju za svoj Java kod, možda biste trebali istražiti Javadoc. Javadoc vam omogućuje automatsko dokumentiranje vašeg Java koda.