GitBook er en plattform som lar deg bygge dokumentasjonssider eller firmawikier. Du kan bruke den til å dokumentere alle slags ting, fra kode til APIer og hvordan du bruker et programvareprodukt.

GitBook bruker en lignende prosess som GitHub-depoter. Hovedkopien av dokumentasjonen fungerer som en "master"-kopi. Du kan da lage "utkast", som ligner på "grener".

Denne prosessen lar mange brukere jobbe på ett enkelt dokumentasjonssted mens de håndterer eller forhindrer konflikter. Det lar også endringer fra forskjellige grener gå gjennom en gjennomgangsprosess før du slår dem sammen.

Hvordan begynne å bruke GitBook

Du kan velge mellom flere GitBook-priser planer. Priser vil avhenge av om du bruker GitBook for åpen kildekode-prosjekter, personlig bruk eller privat teamsamarbeid. GitBook er gratis å bruke hvis du bruker den til åpen kildekode-prosjekter.

GitBook støtter Markdown, et populært merkespråk med mange fordeler for skriving eller dokumentering på nettet.

GitBook integreres også med GitHub, en plattform for hosting, lagring og redigering av kode

. Du kan koble GitBook-kontoen din direkte til GitHub-kontoen din ved å logge på med GitHub-legitimasjonen din.

  1. Registrer deg på GitBook. Hvis du har din egen GitHub-konto, kan du klikke på Registrer deg med GitHub.
  2. Når du har logget på, vil GitBook omdirigere deg til en ny intern wiki. Den vil også forhåndsutfylle wikien din med noe eksempelinnhold.

En oversikt over GitBook-grensesnittet

GitBook har flere funksjoner som lar deg bygge og gjøre endringer på dokumentasjonssiden din.

  1. Topppanelet lar deg lage nye utkast, se endringsloggen eller se andre diskusjoner eller vedlegg.
  2. Sidefeltet lengst til venstre lar deg lage flere mellomrom. Du kan bruke separate rom for forskjellige prosjekter slik at du kan skille og organisere dokumentasjonsområdene dine. Du kan utvide eller lukke sidefeltet.
  3. Det venstre panelet fungerer som en meny for dokumentasjonssiden. Du kan vise sidene på dokumentasjonsnettstedet ditt og bruke det til å opprette grupper og nestede sider. Du kan også navigere på tvers av nettstedet ved å bruke lenkene som er gitt.
  4. Bunnpanelet inneholder knapper som er avgjørende for versjonskontrollprosessen. Du kan legge til et navn for utkastet ditt, slå sammen en endring eller sende inn endringen for gjennomgang.

Hvordan lage et nytt utkast

Du kan opprette et nytt utkast ved å opprette en ny endringsforespørsel og gjøre endringer i den.

  1. I topppanelet klikker du på Endringsforespørsler.
  2. På det nye panelet som vises på høyre side, klikk på Utkast fanen. Dette vil vise deg alle dine aktive utkast.
  3. Herfra kan du klikke på et eksisterende utkast for å åpne det. For å lage et nytt utkast, klikk på Ny endringsforespørsel, og vent til siden er ferdig lastet.
  4. Klikk på i bunnpanelet Skriv inn et emne. Dette vil åpne et vindu der du kan gi det nye utkastet et navn. For eksempel, Ny side - Hvordan sette opp kodebase.

Hvordan lage sider og grupper

Når du har et utkast, kan du begynne å gjøre endringer i dokumentasjonen. GitBook lagrer endringene dine i utkastet, slik at de ikke påvirker hovedkopien. Du kan bruke sidefeltet til venstre for å legge til sider og sidegrupper.

  1. Opprett en ny side ved å klikke på Ny side lenke nederst i sidefeltet, og velge Ny dokumentside fra rullegardinmenyen. Alternativt kan du holde musepekeren under en eksisterende side og klikke på den blå i tillegg til knapp.
  2. For å opprette en ny sidegruppe, klikk på Ny side, og velg Ny gruppe alternativet fra rullegardinmenyen.
  3. Du kan gi siden nytt navn ved å klikke på de tre prikkene ved siden av siden eller gruppen, og velge Gi nytt navn.
  4. Begynn å legge til innhold for å fylle ut den nye siden din. Du kan legge til enkelt innhold som tekst eller overskrifter. GitBook lar deg også legge til andre innholdsblokker som bilder, filvedlegg, tabeller, faner eller kodebiter. Det er også muligheten til å legge til andre integrasjoner som YouTube-innbygginger eller Google Docs-innhold.
  5. Klikk på Ulik utsikt -knappen i bunnpanelet for å se forskjellene mellom utkastet og den originale hoveddokumentasjonseksemplaret.
  6. Når du er ferdig med å skrive innholdet ditt, kan du klikke videre Slå sammen, Send inn og slå sammen, eller Send inn for vurdering.

Du kan få tilgang til delelenken fra topppanelet til GitBook. Du må være ute av et utkast og se hoveddokumentasjonseksemplaret for å kunne se lenken.

  1. Som standard er synligheten til dokumentasjonssiden din "ulistet". Dette betyr at du kan få tilgang til dokumentasjonssiden ved hjelp av en privat lenke, og ikke via søkemotorer. I topppanelet klikker du på Unotert knapp.
  2. Velg ønsket synlighetsinnstillinger fra rullegardinmenyen. Merk at GitBook kan låse visse synlighetsinnstillinger, og du må kanskje oppgradere for å få tilgang til dem.
  3. Under listen over synlighetsinnstillinger er det en lenke som du kan dele med andre brukere som skal bruke dokumentasjonssiden din. Kopier denne lenken for å dele den med andre.
  4. Klikk på under lenken Link og domeneinnstillinger. Det er her du kan koble til et tilpasset domenenavn, eller endre deler av nettadressen. Hvis du bruker et tilpasset domene, kan du se Gitbooks dokumentasjon om hvordan du konfigurerer DNS på riktig måte.

Opprette dokumentasjon ved hjelp av GitBook

GitBook lar deg lage og jobbe med dokumentasjonssider eller firmawikier i samarbeid. GitBook låner konsepter fra GitHub som grener og sammenslåing for å kontrollere en hovedkopi og håndtere eventuelle konflikter.

Du kan lage et nytt utkast for å legge til dine egne individuelle endringer i dokumentasjonen. Innenfor utkastet kan du gjøre endringer i innholdet, samt legge til nye sider eller sidegrupper. Når du er ferdig med å gjøre endringene, kan du enten slå dem sammen eller sende dem til vurdering.

Hvis du lager intern dokumentasjon for Java-koden din, kan det være lurt å utforske Javadoc. Javadoc lar deg dokumentere Java-koden automatisk.