GitBook is een platform waarmee jij en je team documentatiesites kunnen maken en eraan kunnen samenwerken. GitBook doet dit door gebruik te maken van concepten voor versiebeheer, zoals vertakking en samenvoeging.

Omdat veel teamleden aan één documentatiesite kunnen werken, kunt u met GitBook afzonderlijke concepten maken en beheren. U kunt ook de verschillen bekijken tussen uw huidige concept en de kopie van de hoofddocumentatie.

Er zijn verschillende soorten blokken beschikbaar die u aan uw wiki-pagina's kunt toevoegen. Dit omvat koppen, alinea's, afbeeldingen, hints, tabellen, codeblokken, bestandsbijlagen en meer.

Inhoudsblokken toevoegen in GitBook

U kunt een lijst bekijken van de beschikbare inhoudsblokken die u aan een pagina kunt toevoegen. U kunt dit doen door ergens op de pagina te klikken en op de plus symbool dat verschijnt. U kunt ook direct zoeken naar een specifiek contentblok.

U kunt inhoud toevoegen met Markdown. Als je Markdown nog niet eerder hebt gebruikt, kun je meer te weten komen over:

hoe aan de slag te gaan met Markdown. U kunt ook meer lezen over waarom Markdown zo populair is.

Alinea's, lijsten, aanhalingstekens of codeblokken toevoegen

Om lijsten, alinea's, aanhalingstekens, codeblokken of andere eenvoudige inhoudsblokken toe te voegen, opent u de vervolgkeuzelijst en selecteert u uit de beschikbare typen.

  1. Klik op een pagina op uw documentatiesite op de plus op de locatie waar u uw inhoud wilt toevoegen.
  2. Vanuit de vervolgkeuzelijst kunt u door de lijst bladeren om de verschillende inhoudsopties te bekijken.
  3. Selecteer hier elk eenvoudig inhoudstype, zoals een alinea, codeblok, kop of citaat. GitBook zal de inhoud automatisch aanpassen aan het formaat dat je hebt geselecteerd.

Afbeeldingen of bestandsbijlagen toevoegen

Om afbeeldingen toe te voegen, gebruik de vervolgkeuzelijst om de Afbeeldingen optie voor inhoudsblokkering. Om bestanden toe te voegen, selecteer de Bestanden invoegen optie in plaats daarvan. U kunt dan het rechterpaneel gebruiken om uw geüploade afbeeldingen en bestanden te beheren.

  1. Open een pagina op uw documentatiesite. Klik op de plus om de vervolgkeuzelijst voor beschikbare inhoudsblokken te openen.
  2. Selecteer Afbeeldingen invoegen.
  3. In het rechterpaneel dat verschijnt, zijn er drie tabbladen. De Bestanden tab kunt u uw eigen afbeeldingsbestand uploaden. De URL tabblad kunt u online naar een afbeelding linken. U kunt ook de. openen Unsplash tabblad. Hier kunt u bestaande foto's selecteren waarvoor geen toeschrijving vereist is.
  4. Nadat u een afbeelding heeft toegevoegd, klikt u op de drie stippen knop in de linkerbovenhoek van de afbeelding. Dit opent een vervolgkeuzelijst waar u de afbeelding kunt uitlijnen of verwijderen. Je kunt de afbeelding ook een bijschrift geven.
  5. Om bestanden in te voegen, plaatst u uw cursor ergens op een pagina op uw documentatiesite. Klik op de plus om de vervolgkeuzelijst met typen inhoudsblokken te openen. Klik deze keer op de bestanden invoegen keuze.
  6. Een soortgelijk rechterpaneel verschijnt, zodat u elke bestandsbijlage kunt uploaden in plaats van een afbeelding. Klik op Bestanden doorbladeren om een ​​bestand te selecteren dat lokaal op uw computer is opgeslagen.
  7. Het bestand verschijnt in de lijst. Klik op het bestand en GitBook zal een inhoudsblok maken met de bestandsbijlage op de pagina die u hebt geopend. Als u op dit inhoudsblok klikt, wordt de bestandsbijlage gedownload.

Tips toevoegen

U kunt ook hints aan uw pagina toevoegen. U kunt het pictogram voor de hints wijzigen om rood voor gevaar, oranje voor waarschuwing, blauw voor informatie of groen voor succes te gebruiken.

  1. Om een ​​hint toe te voegen, klik op de plus om de vervolgkeuzelijst voor beschikbare inhoudsblokken te openen.
  2. Selecteer Tip:.
  3. Dit zal een hint aan uw pagina toevoegen. Het type hint is standaard "informatie" en bevat een blauw pictogram.
  4. U kunt het type hint wijzigen door op het pictogram te klikken. Dit doorloopt de vier verschillende hinttypes.

Tabellen toevoegen

U kunt tabellen toevoegen door de te selecteren tafel optie uit de vervolgkeuzelijst. Zodra u de tabel op de pagina heeft, kunt u nieuwe rijen of kolommen toevoegen. U kunt ook de namen en gegevenstypen van de kolommen wijzigen en de gegevens in de tabel wijzigen.

  1. Klik op de plus om de vervolgkeuzelijst voor beschikbare inhoudsblokken te openen.
  2. Selecteer Tafel.
  3. Klik op de kop van een kolom in de tabel. Dit opent een nieuw kleiner menu, waar u de naam van de geselecteerde kolom kunt wijzigen. Met dit menu kunt u ook de geselecteerde kolom verwijderen of verbergen. Voor bepaalde kolomgegevenstypen kunt u ook de inhoud in de kolom uitlijnen.
  4. Het geselecteerde gegevenstype voor de kolommen is standaard "Tekst". Klik op de knop met de T symbool om het gegevenstype te wijzigen. U kunt dit wijzigen in een getal, selectievakje, vervolgkeuzelijst, bestandsbijlage, beoordeling of meer.
  5. Klik op de zes stippen icoon in de buurt van de linkerbovenhoek van de tafel. Hier kunt u nieuwe kolommen en rijen invoegen of de hele tabel verwijderen. U kunt ook bepaalde kolommen verbergen of weergeven, of andere eigenschappen voor de tabel wijzigen.

Hoe paginalinkblokken toe te voegen

Paginalinkblokken zijn links die de hele regel op de pagina in beslag nemen. Wanneer u de link toevoegt, moet u linken naar de pagina die wordt geopend wanneer iemand erop klikt.

  1. Klik op de plus om de vervolgkeuzelijst voor beschikbare inhoudsblokken te openen.
  2. Klik op pagina link.
  3. Kies in de nieuwe vervolgkeuzelijst de pagina waarnaar u linkt.
  4. Uw paginalink verschijnt in een blok op de pagina.

GitBook gebruiken voor documentatie

GitBook is een documentatietool die gebruikmaakt van concepten voor versiebeheer, zoals vertakking en samenvoeging. Hierdoor kan meer dan één lid van het team tegelijkertijd aan de documentatie werken. Het helpt ook om eventuele conflicten te beheren.

Je kunt allerlei contentblokken aan een pagina toevoegen. U kunt koppen, alinea's, codeblokken of opsommingstekens gebruiken om uw inhoud opnieuw op te maken. U kunt het type hint, het bericht en het pictogramtype van hints wijzigen en de kolommen van een tabel aanpassen.

Op het tabblad Bestanden kunt u afbeeldingen en bestandsbijlagen beheren die u naar de site uploadt. Met paginalinks kunt u grote links maken die gebruikers gemakkelijk kunnen herkennen.

Als u documentatie maakt met betrekking tot de Go-taal, kunt u Godoc gebruiken. Met Godoc kunt u uw Go-code automatisch documenteren.