GitBook is een platform waarmee u documentatiesites of bedrijfswiki's kunt bouwen. Je kunt het gebruiken om allerlei dingen te documenteren, van code tot API's en hoe je een softwareproduct gebruikt.
GitBook gebruikt een soortgelijk proces als GitHub-repositories. De hoofdkopie van de documentatie fungeert als een "master" -kopie. U kunt dan "concepten" maken die lijken op "takken".
Dit proces stelt veel gebruikers in staat om op één documentatiesite te werken terwijl ze conflicten afhandelen of voorkomen. Het staat ook toe dat wijzigingen van verschillende branches een beoordelingsproces doorlopen voordat je ze samenvoegt.
Beginnen met GitBook te gebruiken
U kunt kiezen uit meerdere GitBook-prijzen plannen. De prijs hangt af van of je GitBook gebruikt voor open source-projecten, persoonlijk gebruik of privé-teamsamenwerking. GitBook is gratis te gebruiken als je het gebruikt voor open source-projecten.
GitBook ondersteunt Markdown, een populaire opmaaktaal met veel voordelen voor schrijven of documenteren op het web.
GitBook integreert ook met GitHub, een platform voor het hosten, opslaan en bewerken van code. U kunt uw GitBook-account rechtstreeks aan uw GitHub-account koppelen door u aan te melden met uw GitHub-inloggegevens.
- Meld u aan bij GitBook. Als je een eigen GitHub-account hebt, kun je klikken op Aanmelden met GitHub.
- Zodra je bent ingelogd, zal GitBook je doorverwijzen naar een nieuwe interne wiki. Het zal je wiki ook vooraf vullen met wat voorbeeldinhoud.
Een overzicht van de GitBook-interface
GitBook heeft verschillende functies waarmee u uw documentatiesite kunt bouwen en wijzigen.
- In het bovenste paneel kunt u nieuwe concepten maken, de wijzigingsgeschiedenis bekijken of andere discussies of bijlagen bekijken.
- Met de meest linkse zijbalk kunt u meerdere ruimtes maken. U kunt aparte ruimtes gebruiken voor verschillende projecten, zodat u uw documentatiegebieden kunt scheiden en ordenen. U kunt de zijbalk uitvouwen of sluiten.
- Het linkerdeelvenster fungeert als menu voor de documentatiesite. U kunt de pagina's op uw documentatiesite bekijken en deze gebruiken om groepen en geneste pagina's te maken. U kunt ook door de site navigeren met behulp van de aangeboden links.
- Het onderste paneel bevat knoppen die essentieel zijn voor het versiebeheerproces. U kunt een naam voor uw concept toevoegen, een wijziging samenvoegen of de wijziging ter beoordeling indienen.
Een nieuw concept maken
U kunt een nieuw concept maken door een nieuw wijzigingsverzoek te maken en daarin wijzigingen aan te brengen.
- Klik in het bovenste paneel op Verander verzoeken.
- Klik in het nieuwe paneel dat aan de rechterkant verschijnt op de Voorlopige versie tabblad. Dit toont u al uw actieve concepten.
- Vanaf hier kunt u op een bestaand concept klikken om het te openen. Om een nieuw concept aan te maken, klik op Nieuw wijzigingsverzoeken wacht tot de pagina klaar is met laden.
- Klik in het onderste paneel op Voer een onderwerp in. Dit opent een venster waarin u het nieuwe concept een naam kunt geven. Bijvoorbeeld, Nieuwe pagina - Codebase instellen.
Pagina's en groepen maken
Zodra u een concept heeft, kunt u beginnen met het aanbrengen van wijzigingen in de documentatie. GitBook slaat uw wijzigingen op in het concept, zodat ze geen invloed hebben op de hoofdkopie. U kunt de linkerzijbalk gebruiken om pagina's en paginagroepen toe te voegen.
- Maak een nieuwe pagina door te klikken op de Nieuwe pagina link onderaan de zijbalk en selecteer Nieuwe documentpagina uit de vervolgkeuzelijst. U kunt ook onder een bestaande pagina zweven en op de blauwe. klikken plus knop.
- Om een nieuwe paginagroep aan te maken, klik op Nieuwe paginaen selecteer de Nieuwe groep optie uit de vervolgkeuzelijst.
- U kunt de pagina hernoemen door op de drie stippen naast de pagina of groep te klikken en te selecteren Hernoemen.
- Begin met het toevoegen van inhoud om uw nieuwe pagina te vullen. U kunt eenvoudige inhoud zoals tekst of koppen toevoegen. Met GitBook kunt u ook andere inhoudsblokken toevoegen, zoals afbeeldingen, bestandsbijlagen, tabellen, tabbladen of codefragmenten. Er is ook de mogelijkheid om andere integraties toe te voegen, zoals YouTube-embeds of Google Documenten-inhoud.
- Klik op de Diff weergave knop in het onderste paneel om de verschillen tussen uw concept en de originele kopie van de hoofddocumentatie te bekijken.
- Als u klaar bent met het schrijven van uw inhoud, kunt u klikken op Samenvoegen, Verzenden en samenvoegen, of Ter beoordeling indienen.
Je hebt toegang tot de deellink vanuit het bovenste paneel van GitBook. U moet geen concept hebben en de kopie van de hoofddocumentatie bekijken om de link te kunnen zien.
- Standaard is de zichtbaarheid van uw documentatiesite "niet vermeld". Dit betekent dat u de documentatiesite kunt bereiken via een privélink, en niet via zoekmachines. Klik in het bovenste paneel op de niet vermeld knop.
- Selecteer de gewenste zichtbaarheidsinstellingen in de vervolgkeuzelijst. Houd er rekening mee dat GitBook bepaalde zichtbaarheidsinstellingen kan vergrendelen en dat u mogelijk moet upgraden om toegang te krijgen.
- Onder de lijst met zichtbaarheidsinstellingen bevindt zich een link die u kunt delen met andere gebruikers die uw documentatiesite gaan gebruiken. Kopieer deze link om deze met anderen te delen.
- Klik onder de link op Link- en domeininstellingen. Hier kunt u een aangepaste domeinnaam koppelen of een deel van de URL wijzigen. Als u een aangepast domein gebruikt, kunt u bekijken Gitbook's documentatie over hoe u uw DNS correct kunt configureren.
Documentatie maken met GitBook
Met GitBook kunt u samen documentatiesites of bedrijfswiki's maken en eraan werken. GitBook leent concepten van GitHub zoals branches en mergen om een masterkopie te beheren en eventuele conflicten te beheren.
U kunt een nieuw concept maken om uw eigen individuele wijzigingen aan de documentatie toe te voegen. Binnen het concept kunt u wijzigingen aanbrengen in de inhoud en nieuwe pagina's of paginagroepen toevoegen. Als u klaar bent met het aanbrengen van uw wijzigingen, kunt u ze samenvoegen of ter beoordeling indienen.
Als u interne documentatie voor uw Java-code maakt, wilt u misschien Javadoc verkennen. Met Javadoc kunt u uw Java-code automatisch documenteren.
