Sådan opretter du en simpel intern Wiki ved hjælp af Gitbook

Sådan opretter du en simpel intern Wiki ved hjælp af Gitbook

GitBook er en platform, der giver dig mulighed for at bygge dokumentationssider eller firmawikier. Du kan bruge det til at dokumentere alle mulige ting, fra kode til API'er og hvordan man bruger et softwareprodukt.





GitBook bruger en lignende proces som GitHub-depoter. Hovedkopien af ​​dokumentationen fungerer som en 'master'-kopi. Du kan derefter oprette 'kladder', som ligner 'grene'.





Denne proces giver mange brugere mulighed for at arbejde på et enkelt dokumentationssted, mens de håndterer eller forebygger konflikter. Det giver også ændringer fra forskellige grene mulighed for at gennemgå en gennemgang, før du flette dem.





Sådan begynder du at bruge GitBook

Du kan vælge mellem flere GitBook-priser planer. Prisen vil afhænge af, om du bruger GitBook til open source-projekter, personlig brug eller privat teamsamarbejde. GitBook er gratis at bruge, hvis du bruger den til open source-projekter.

GitBook understøtter Markdown, et populært opmærkningssprog med mange fordele til at skrive eller dokumentere på nettet.



hvordan man rydder al cache på Android

GitBook integreres også med GitHub, en platform til hosting, lagring og redigering af kode . Du kan linke din GitBook-konto direkte til din GitHub-konto ved at logge ind med dine GitHub-legitimationsoplysninger.

  1. Tilmeld dig GitBook. Hvis du har din egen GitHub-konto, kan du klikke på Tilmeld dig med GitHub .
  2. Når du har logget ind, omdirigerer GitBook dig til en ny intern wiki. Det vil også på forhånd udfylde din wiki med noget eksempelindhold.

En oversigt over GitBook-grænsefladen

GitBook har flere funktioner, der giver dig mulighed for at bygge og foretage ændringer på dit dokumentationssted.





  1. Det øverste panel giver dig mulighed for at oprette nye kladder, se ændringshistorikken eller se andre diskussioner eller vedhæftede filer.
  2. Sidebjælken længst til venstre giver dig mulighed for at oprette flere mellemrum. Du kan bruge separate rum til forskellige projekter, så du kan adskille og organisere dine dokumentationsområder. Du kan udvide eller lukke sidebjælken.
  3. Det venstre panel fungerer som en menu for dokumentationssiden. Du kan se siderne på dit dokumentationswebsted og bruge det til at oprette grupper og indlejrede sider. Du kan også navigere på tværs af webstedet ved hjælp af de viste links.
  4. Det nederste panel indeholder knapper, der er afgørende for versionskontrolprocessen. Du kan tilføje et navn til din kladde, flette en ændring eller indsende ændringen til gennemgang.

Sådan opretter du et nyt udkast

Du kan oprette en ny kladde ved at oprette en ny ændringsanmodning og foretage ændringer i den.

hvordan slukker du facebook live notifikationer
  1. Klik på i det øverste panel Ændringsanmodninger .
  2. På det nye panel, der vises i højre side, skal du klikke på Udkast fanen. Dette vil vise dig alle dine aktive kladder.
  3. Herfra kan du klikke på en eksisterende kladde for at åbne den. For at oprette en ny kladde, klik på Ny ændringsanmodning , og vent på, at siden er færdig med at blive indlæst.
  4. Klik på i det nederste panel Indtast et emne . Dette åbner et vindue, hvor du kan give det nye udkast et navn. For eksempel, Ny side - Sådan opsætter du kodebase .

Sådan opretter du sider og grupper

Når du har en kladde, kan du begynde at lave ændringer i dokumentationen. GitBook gemmer dine ændringer inde i kladden, så de ikke påvirker masterkopien. Du kan bruge den venstre sidebjælke til at tilføje sider og sidegrupper.





  1. Opret en ny side ved at klikke på Ny side link nederst i sidebjælken og vælge Ny dokumentside fra rullemenuen. Alternativt kan du svæve under en eksisterende side og klikke på den blå plus knap.
  2. For at oprette en ny sidegruppe, klik på Ny side , og vælg Ny gruppe mulighed fra rullemenuen.
  3. Du kan omdøbe siden ved at klikke på de tre prikker ved siden af ​​siden eller gruppen og vælge Omdøb .
  4. Begynd at tilføje indhold for at udfylde din nye side. Du kan tilføje simpelt indhold såsom tekst eller overskrifter. GitBook giver dig også mulighed for at tilføje andre indholdsblokke såsom billeder, vedhæftede filer, tabeller, faner eller kodestykker. Der er også mulighed for at tilføje andre integrationer såsom YouTube-indlejringer eller Google Docs-indhold.
  5. Klik på Forskellig udsigt knappen i det nederste panel for at se forskellene mellem dit udkast og den originale kopi af masterdokumentationen.
  6. Når du er færdig med at skrive dit indhold, kan du klikke videre Fusionere , Send og flet , eller Send til gennemgang .

Du kan få adgang til delelinket fra toppanelet på GitBook. Du skal være ude af en kladde og se hoveddokumentationen for at kunne se linket.

  1. Som standard er synligheden af ​​dit dokumentationswebsted 'ulistet'. Det betyder, at du kan få adgang til dokumentationssiden ved hjælp af et privat link, og ikke via søgemaskiner. I toppanelet skal du klikke på Unoteret knap.
  2. Vælg dine ønskede synlighedsindstillinger fra rullemenuen. Bemærk, at GitBook kan låse visse synlighedsindstillinger, og du skal muligvis opgradere for at få adgang til dem.
  3. Under listen over synlighedsindstillinger er der et link, som du kan dele med andre brugere, der vil bruge dit dokumentationswebsted. Kopier dette link for at dele det med andre.
  4. Klik på under linket Link og domæneindstillinger . Det er her du kan linke et brugerdefineret domænenavn eller ændre en del af URL'en. Hvis du bruger et brugerdefineret domæne, kan du se Gitbooks dokumentation hvordan du konfigurerer din DNS korrekt.

Oprettelse af dokumentation ved hjælp af GitBook

GitBook giver dig mulighed for i fællesskab at skabe og arbejde på dokumentationssider eller virksomhedswikier. GitBook låner koncepter fra GitHub som filialer og sammensmeltning for at kontrollere en masterkopi og håndtere eventuelle konflikter.

Du kan oprette en ny kladde for at tilføje dine egne individuelle ændringer til dokumentationen. I udkastet kan du foretage ændringer i indholdet samt tilføje nye sider eller sidegrupper. Når du er færdig med at foretage dine ændringer, kan du enten flette dem eller sende dem til gennemgang.

Hvis du opretter intern dokumentation til din Java-kode, vil du måske udforske Javadoc. Javadoc giver dig mulighed for automatisk at dokumentere din Java-kode.