GitBook er en plattform som lar deg og teamet ditt lage og samarbeide om dokumentasjonssider. GitBook gjør dette ved å bruke versjonskontrollkonsepter, som forgrening og sammenslåing.
Siden mange teammedlemmer kan jobbe på en enkelt dokumentasjonsside, lar GitBook deg lage og administrere separate utkast. Du kan også se forskjellene mellom gjeldende utkast og hoveddokumentasjonseksemplaret.
Flere typer blokker er tilgjengelige for deg å legge til på wiki-sidene dine. Dette inkluderer overskrifter, avsnitt, bilder, hint, tabeller, kodeblokker, filvedlegg og mer.
Hvordan legge til innholdsblokker i GitBook
Du kan se en liste over tilgjengelige innholdsblokker du kan legge til på en side. Du kan gjøre dette ved å klikke hvor som helst på siden og klikke på i tillegg til symbolet som vises. Du kan også søke direkte etter en bestemt innholdsblokk.
Du kan legge til innhold ved å bruke Markdown. Hvis du ikke har brukt Markdown før, kan du lære mer om hvordan komme i gang med Markdown. Du kan også lese mer om hvorfor Markdown er så populært.
Hvordan legge til avsnitt, lister, sitater eller kodeblokker
For å legge til lister, avsnitt, sitater, kodeblokker eller andre enkle innholdsblokker, åpne rullegardinmenyen og velg fra de tilgjengelige typene.
- På en side på dokumentasjonssiden din klikker du på i tillegg til knappen på stedet der du vil legge til innholdet ditt.
- Fra rullegardinmenyen kan du bla gjennom listen for å se de forskjellige innholdsalternativene.
- Herfra velger du en hvilken som helst enkel innholdstype, for eksempel et avsnitt, kodeblokk, overskrift eller sitat. GitBook vil automatisk endre innholdet for å matche formatet du har valgt.
Hvordan legge til bilder eller filvedlegg
For å legge til bilder, bruk rullegardinmenyen for å velge Bilder alternativ for innholdsblokkering. For å legge til filer, velg Sett inn filer alternativet i stedet. Du kan deretter bruke panelet til høyre for å administrere de opplastede bildene og filene dine.
- Åpne en side på dokumentasjonssiden. Klikk på i tillegg til for å åpne rullegardinmenyen for tilgjengelige innholdsblokker.
- Å velge Sett inn bilder.
- I panelet til høyre som vises, er det tre faner. De Filer fanen lar deg laste opp din egen bildefil. De URL fanen lar deg koble til et bilde på nettet. Du kan også åpne Unsplash fanen. Det er her du kan velge eksisterende bilder som ikke krever attribusjon.
- Når du har lagt til et bilde, klikk på tre prikker -knappen i øverste venstre hjørne av bildet. Dette vil åpne en rullegardin hvor du kan justere bildet, eller slette det. Du kan også gi bildet en bildetekst.
- For å sette inn filer, plasser markøren hvor som helst på en side på dokumentasjonssiden. Klikk på i tillegg til for å åpne rullegardinmenyen for innholdsblokktyper. Denne gangen klikker du på sette inn filer alternativ.
- Et lignende høyre panel vil vises, slik at du kan laste opp et hvilket som helst filvedlegg i stedet for et bilde. Klikk på Bla gjennom filer for å velge en fil som er lagret lokalt på datamaskinen.
- Filen vises på listen. Klikk på filen, og GitBook vil lage en innholdsblokk med filvedlegget på siden du har åpen. Ved å klikke på denne innholdsblokken lastes filvedlegget ned.
Hvordan legge til tips
Du kan også legge til hint på siden din. Du kan endre ikonet for hintene til å bruke rødt for fare, oransje for advarsel, blått for informasjon eller grønt for suksess.
- For å legge til et hint, klikk på i tillegg til for å åpne rullegardinmenyen for tilgjengelige innholdsblokker.
- Å velge Hint.
- Dette vil legge til et hint til siden din. Som standard er hinttypen "informasjon", og inneholder et blått ikon.
- Du kan endre hinttypen ved å klikke på ikonet. Dette vil gå gjennom de fire forskjellige hinttypene.
Hvordan legge til tabeller
Du kan legge til tabeller ved å velge bord alternativet fra rullegardinlisten. Når du har tabellen på siden, kan du legge til nye rader eller kolonner. Du kan også endre navnene og datatypene til kolonnene, og endre dataene i tabellen.
- Klikk på i tillegg til for å åpne rullegardinmenyen for tilgjengelige innholdsblokker.
- Å velge Bord.
- Klikk på overskriften til en kolonne i tabellen. Dette vil åpne en ny mindre meny, hvor du kan endre navnet på den valgte kolonnen. Denne menyen lar deg også slette eller skjule den valgte kolonnen. For visse kolonnedatatyper kan du også justere innholdet inne i kolonnen.
- Som standard er den valgte datatypen for kolonnene "Tekst". Klikk på knappen med T symbol for å endre datatypen. Du kan endre det til et tall, avmerkingsboks, rullegardinmeny, filvedlegg, vurdering eller mer.
- Klikk på seks prikker-ikon nær øverste venstre hjørne av bordet. Her kan du sette inn nye kolonner og rader eller slette hele tabellen. Du kan også skjule eller vise bestemte kolonner, eller endre andre egenskaper for tabellen.
Hvordan legge til sidekoblingsblokker
Sidekoblingsblokker er lenker som tar opp hele linjen på siden. Når du legger til lenken, må du lenke til siden som åpnes når noen klikker på den.
- Klikk på i tillegg til for å åpne rullegardinmenyen for tilgjengelige innholdsblokker.
- Klikk på Sidekobling.
- Fra den nye rullegardinmenyen velger du siden du linker til.
- Sidelenken din vises i en blokk på siden.
Bruke GitBook for dokumentasjon
GitBook er et dokumentasjonsverktøy som bruker versjonskontrollkonsepter som forgrening og sammenslåing. Dette gjør at mer enn ett medlem av teamet kan jobbe med dokumentasjonen samtidig. Det hjelper også å håndtere eventuelle konflikter som oppstår.
Du kan legge til alle slags innholdsblokker på en side. Du kan bruke overskrifter, avsnitt, kodeblokker eller punktpunkter for å formatere innholdet ditt på nytt. Du kan endre hinttypen, meldings- og ikontypen for hint, samt tilpasse kolonnene i en tabell.
Filer-fanen lar deg administrere bilder og filvedlegg som du laster opp til nettstedet. Sidekoblinger lar deg lage store lenker som brukerne enkelt kan oppdage.
Hvis du lager dokumentasjon knyttet til Go-språket, kan du bruke Godoc. Godoc lar deg automatisk dokumentere Go-koden din.