GitBook är en plattform som låter dig och ditt team skapa och samarbeta på dokumentationssajter. GitBook gör detta genom att använda versionskontrollkoncept, såsom förgrening och sammanslagning.
Eftersom många teammedlemmar kan arbeta på en enda dokumentationswebbplats låter GitBook dig skapa och hantera separata utkast. Du kan också se skillnaderna mellan ditt nuvarande utkast och huvuddokumentationen.
Det finns flera typer av block som du kan lägga till på dina wiki-sidor. Detta inkluderar rubriker, stycken, bilder, tips, tabeller, kodblock, filbilagor och mer.
Hur man lägger till innehållsblock i GitBook
Du kan se en lista över tillgängliga innehållsblock som du kan lägga till på en sida. Du kan göra detta genom att klicka var som helst på sidan och klicka på plus symbol som visas. Du kan också söka direkt efter ett specifikt innehållsblock.
Du kan lägga till innehåll med Markdown. Om du inte har använt Markdown tidigare kan du lära dig mer om hur man kommer igång med Markdown. Du kan också läsa mer om varför Markdown är så populärt.
Hur man lägger till stycken, listor, citat eller kodblock
För att lägga till listor, stycken, citat, kodblock eller andra enkla innehållsblock, öppna rullgardinsmenyn och välj bland de tillgängliga typerna.
- På en sida på din dokumentationswebbplats klickar du på plus knappen på den plats där du vill lägga till ditt innehåll.
- Från rullgardinsmenyn kan du bläddra igenom listan för att se de olika innehållsalternativen.
- Härifrån väljer du vilken enkel innehållstyp som helst, till exempel ett stycke, kodblock, rubrik eller citat. GitBook kommer automatiskt att ändra innehållet så att det matchar formatet du har valt.
Hur man lägger till bilder eller filbilagor
För att lägga till bilder, använd rullgardinsmenyn för att välja Bilder alternativet för innehållsblockering. För att lägga till filer, välj Infoga filer alternativ istället. Du kan sedan använda den högra panelen för att hantera dina uppladdade bilder och filer.
- Öppna en sida på din dokumentationswebbplats. Klicka på plus för att öppna rullgardinsmenyn för tillgängliga innehållsblock.
- Välj Infoga bilder.
- I den högra panelen som visas finns det tre flikar. De Filer fliken låter dig ladda upp din egen bildfil. De URL fliken låter dig länka till en bild online. Du kan också öppna Unsplash flik. Det är här du kan välja befintliga foton som inte kräver tillskrivning.
- När du har lagt till en bild, klicka på tre prickar knappen i det övre vänstra hörnet av bilden. Detta öppnar en rullgardinsmeny där du kan justera bilden eller ta bort den. Du kan också ge bilden en bildtext.
- För att infoga filer, placera markören var som helst på en sida på din dokumentationssida. Klicka på plus knappen för att öppna rullgardinsmenyn för innehållsblocktyper. Den här gången klickar du på infoga filer alternativ.
- En liknande högerpanel kommer att visas, så att du kan ladda upp valfri filbilaga istället för en bild. Klicka på Bläddra bland filer för att välja en fil lagrad lokalt på din dator.
- Filen kommer att visas på listan. Klicka på filen så skapar GitBook ett innehållsblock med filbilagan på sidan som du har öppen. Om du klickar på det här innehållsblocket laddas den bifogade filen ned.
Hur man lägger till tips
Du kan också lägga till tips på din sida. Du kan ändra ikonen för tipsen till att använda rött för fara, orange för varning, blått för information eller grönt för framgång.
- För att lägga till en ledtråd, klicka på plus för att öppna rullgardinsmenyn för tillgängliga innehållsblock.
- Välj Ledtråd.
- Detta kommer att lägga till en ledtråd till din sida. Som standard är ledtrådstypen "information" och innehåller en blå ikon.
- Du kan ändra ledtrådstyp genom att klicka på ikonen. Detta kommer att gå igenom de fyra olika tipstyperna.
Hur man lägger till tabeller
Du kan lägga till tabeller genom att välja tabell alternativ från rullgardinsmenyn. När du har tabellen på sidan kan du lägga till nya rader eller kolumner. Du kan också ändra namnen och datatyperna för kolumnerna och ändra data i tabellen.
- Klicka på plus för att öppna rullgardinsmenyn för tillgängliga innehållsblock.
- Välj Tabell.
- Klicka på rubriken i en kolumn i tabellen. Detta öppnar en ny mindre meny, där du kan ändra namnet på den valda kolumnen. Denna meny låter dig också ta bort eller dölja den valda kolumnen. För vissa kolumndatatyper kan du även justera innehållet inuti kolumnen.
- Som standard är den valda datatypen för kolumnerna "Text". Klicka på knappen med T symbol för att ändra datatypen. Du kan ändra det till ett nummer, kryssruta, rullgardinsmeny, filbilaga, betyg eller mer.
- Klicka på sex punkter ikon nära det övre vänstra hörnet av bordet. Här kan du infoga nya kolumner och rader eller ta bort hela tabellen. Du kan också dölja eller visa vissa kolumner, eller ändra andra egenskaper för tabellen.
Hur man lägger till sidolänkblock
Sidlänkblock är länkar som tar upp hela raden på sidan. När du lägger till länken måste du länka till sidan som öppnas när någon klickar på den.
- Klicka på plus för att öppna rullgardinsmenyn för tillgängliga innehållsblock.
- Klicka på sid länk.
- Från den nya rullgardinsmenyn väljer du sidan som du länkar till.
- Din sidlänk kommer att visas i ett block på sidan.
Använder GitBook för dokumentation
GitBook är ett dokumentationsverktyg som använder versionskontrollkoncept som förgrening och sammanslagning. Detta gör att mer än en medlem i teamet kan arbeta med dokumentationen samtidigt. Det hjälper också att hantera eventuella konflikter som uppstår.
Du kan lägga till alla typer av innehållsblock på en sida. Du kan använda rubriker, stycken, kodblock eller punktpunkter för att formatera om ditt innehåll. Du kan ändra ledtrådstyp, meddelande och ikontyp för tips, samt anpassa kolumnerna i en tabell.
Fliken Filer låter dig hantera bilder och bifogade filer som du laddar upp till webbplatsen. Sidlänkar låter dig skapa stora länkar som användarna enkelt kan se.
Om du skapar dokumentation relaterad till Go-språket kan du använda Godoc. Godoc låter dig automatiskt dokumentera din Go-kod.
