GitBook er en platform, der giver dig og dit team mulighed for at oprette og samarbejde om dokumentationssider. GitBook gør dette ved at bruge versionskontrolkoncepter, såsom forgrening og fletning.
Da mange teammedlemmer kan arbejde på et enkelt dokumentationssted, giver GitBook dig mulighed for at oprette og administrere separate kladder. Du kan også se forskellene mellem dit nuværende udkast og hoveddokumentationen.
Der er flere typer blokering, som du kan tilføje til dine wiki-sider. Dette inkluderer overskrifter, afsnit, billeder, tip, tabeller, kodeblokke, vedhæftede filer og mere.
Sådan tilføjes indholdsblokke i GitBook
Du kan se en liste over de tilgængelige indholdsblokke, du kan tilføje til en side. Du kan gøre dette ved at klikke hvor som helst på siden og klikke på plus symbol, der vises. Du kan også søge direkte efter en bestemt indholdsblok.
Du kan tilføje indhold ved hjælp af Markdown. Hvis du ikke har brugt Markdown før, kan du lære mere om hvordan man kommer i gang med Markdown. Du kan også læse mere om hvorfor Markdown er så populær.
Sådan tilføjer du afsnit, lister, citater eller kodeblokke
For at tilføje lister, afsnit, citater, kodeblokke eller andre simple indholdsblokke skal du åbne rullemenuen og vælge mellem de tilgængelige typer.
- På en side på dit dokumentationswebsted skal du klikke på plus knappen på det sted, hvor du vil tilføje dit indhold.
- Fra rullemenuen kan du rulle gennem listen for at se de forskellige indholdsmuligheder.
- Herfra skal du vælge en hvilken som helst simpel indholdstype, såsom et afsnit, kodeblok, overskrift eller citat. GitBook vil automatisk ændre indholdet, så det matcher det format, du har valgt.
Sådan tilføjer du billeder eller vedhæftede filer
For at tilføje billeder skal du bruge rullemenuen til at vælge Billeder mulighed for indholdsblokering. For at tilføje filer skal du vælge Indsæt filer mulighed i stedet for. Du kan derefter bruge panelet til højre til at administrere dine uploadede billeder og filer.
- Åbn en side på dit dokumentationswebsted. Klik på plus knappen for at åbne rullemenuen for tilgængelige indholdsblokke.
- Vælg Indsæt billeder.
- I det højre panel, der vises, er der tre faner. Det Filer fanen giver dig mulighed for at uploade din egen billedfil. Det URL fanen giver dig mulighed for at linke til et billede online. Du kan også åbne Unsplash fanen. Det er her du kan vælge eksisterende billeder, der ikke kræver tilskrivning.
- Når du har tilføjet et billede, skal du klikke på tre prikker knappen placeret i øverste venstre hjørne af billedet. Dette åbner en rullemenu, hvor du kan justere billedet eller slette det. Du kan også give billedet en billedtekst.
- For at indsætte filer skal du placere markøren hvor som helst på en side på dit dokumentationswebsted. Klik på plus knappen for at åbne rullemenuen med indholdsbloktyper. Denne gang skal du klikke på indsætte filer mulighed.
- Et lignende panel til højre vises, så du kan uploade enhver fil vedhæftet fil i stedet for et billede. Klik på Gennemse filer for at vælge en fil, der er gemt lokalt på din computer.
- Filen vises på listen. Klik på filen, og GitBook vil oprette en indholdsblok med den vedhæftede fil på den side, du har åben. Ved at klikke på denne indholdsblok downloades den vedhæftede fil.
Sådan tilføjer du tip
Du kan også tilføje tip til din side. Du kan ændre ikonet for hints til at bruge rødt for fare, orange for advarsel, blåt for information eller grønt for succes.
- For at tilføje et tip, klik på plus knappen for at åbne rullemenuen for tilgængelige indholdsblokke.
- Vælg Antydning.
- Dette vil tilføje et tip til din side. Som standard er tiptypen "information" og indeholder et blåt ikon.
- Du kan ændre tiptypen ved at klikke på ikonet. Dette vil gennemgå de fire forskellige tiptyper.
Sådan tilføjes tabeller
Du kan tilføje tabeller ved at vælge bord mulighed fra rullelisten. Når du har tabellen på siden, kan du tilføje nye rækker eller kolonner. Du kan også ændre navnene og datatyperne for kolonnerne og ændre dataene i tabellen.
- Klik på plus knappen for at åbne rullemenuen for tilgængelige indholdsblokke.
- Vælg Bord.
- Klik på overskriften for en kolonne i tabellen. Dette åbner en ny mindre menu, hvor du kan ændre navnet på den valgte kolonne. Denne menu giver dig også mulighed for at slette eller skjule den valgte kolonne. For visse kolonnedatatyper kan du også justere indholdet inde i kolonnen.
- Som standard er den valgte datatype for kolonnerne "Tekst". Klik på knappen med T symbol for at ændre datatypen. Du kan ændre det til et nummer, afkrydsningsfelt, dropdown, vedhæftet fil, bedømmelse eller mere.
- Klik på seks prikker ikon nær øverste venstre hjørne af bordet. Her kan du indsætte nye kolonner og rækker eller slette hele tabellen. Du kan også skjule eller vise bestemte kolonner eller ændre andre egenskaber for tabellen.
Sådan tilføjes sidelinkblokke
Sidelinkblokke er links, der fylder hele linjen på siden. Når du tilføjer linket, skal du linke til siden, der åbnes, når nogen klikker på det.
- Klik på plus knappen for at åbne rullemenuen for tilgængelige indholdsblokke.
- Klik på Sidelink.
- Fra den nye rullemenu skal du vælge den side, du linker til.
- Dit sidelink vises inde i en blok på siden.
Brug af GitBook til dokumentation
GitBook er et dokumentationsværktøj, der bruger versionskontrolkoncepter såsom forgrening og fletning. Dette giver mere end ét medlem af teamet mulighed for at arbejde på dokumentationen samtidigt. Det hjælper også med at håndtere eventuelle konflikter, der opstår.
Du kan tilføje alle slags indholdsblokke til en side. Du kan bruge overskrifter, afsnit, kodeblokke eller punktopstillinger til at omformatere dit indhold. Du kan ændre tiptypen, beskeden og ikontypen for tip, samt tilpasse kolonnerne i en tabel.
Fanen Filer giver dig mulighed for at administrere billeder og vedhæftede filer, som du uploader til webstedet. Sidelinks giver dig mulighed for at oprette store links, som brugerne nemt kan få øje på.
Hvis du opretter dokumentation relateret til Go-sproget, kan du bruge Godoc. Godoc giver dig mulighed for automatisk at dokumentere din Go-kode.
