Cum să creezi un Wiki intern simplu folosind Gitbook

Cum să creezi un Wiki intern simplu folosind Gitbook

GitBook este o platformă care vă permite să construiți site-uri de documentare sau wiki-uri de companie. Îl poți folosi pentru a documenta tot felul de lucruri, de la cod la API-uri și cum să folosești un produs software.



GitBook folosește un proces similar cu depozitele GitHub. Copia principală a documentației acționează ca o copie „master”. Puteți crea apoi „schițe”, care sunt similare cu „ramuri”.





Acest proces permite multor utilizatori să lucreze pe un singur site de documentare în timp ce gestionează sau previn conflictele. De asemenea, permite modificărilor din diferite ramuri să treacă printr-un proces de revizuire înainte de a le îmbina.





cum se reduce utilizarea ramului Windows 10

Cum să începeți să utilizați GitBook

Puteți alege dintre mai multe Prețuri GitBook planuri. Prețul va depinde dacă utilizați GitBook pentru proiecte open source, uz personal sau colaborare privată în echipă. GitBook este gratuit de utilizat dacă îl utilizați pentru proiecte open source.

GitBook acceptă Markdown, un limbaj de marcare popular cu multe beneficii pentru scriere sau documentare pe web.



GitBook se integrează și cu GitHub, o platformă pentru găzduirea, stocarea și editarea codului . Vă puteți conecta contul GitBook direct la contul GitHub, conectându-vă folosind acreditările GitHub.

mouse-ul Windows 10 se mișcă singur
  1. Înscrieți-vă la GitBook. Dacă aveți propriul cont GitHub, puteți da clic pe Înscrieți-vă cu GitHub .
  2. După ce v-ați conectat, GitBook vă va redirecționa către un nou wiki intern. De asemenea, va pre-popula wiki-ul dvs. cu niște mostre de conținut.

O prezentare generală a interfeței GitBook

GitBook are mai multe funcții care vă permit să construiți și să faceți modificări site-ului dvs. de documentare.





  1. Panoul de sus vă permite să creați schițe noi, să vizualizați istoricul modificărilor sau să vizualizați orice alte discuții sau atașamente.
  2. Bara laterală din stânga vă permite să creați mai multe spații. Puteți folosi spații separate pentru diferite proiecte, astfel încât să puteți separa și organiza zonele de documentare. Puteți extinde sau închide bara laterală.
  3. Panoul din stânga acționează ca un meniu pentru site-ul de documentare. Puteți vizualiza paginile din site-ul dvs. de documentare și îl puteți utiliza pentru a crea grupuri și pagini imbricate. De asemenea, puteți naviga pe site folosind link-urile furnizate.
  4. Panoul de jos include butoane care sunt vitale pentru procesul de control al versiunilor. Puteți adăuga un nume pentru schița dvs., puteți îmbina o modificare sau puteți trimite modificarea spre examinare.

Cum se creează o nouă schiță

Puteți crea o nouă schiță creând o nouă solicitare de modificare și făcând modificări în cadrul acesteia.

  1. În panoul de sus, faceți clic pe Cereri de schimbare .
  2. În noul panou care apare în partea dreaptă, faceți clic pe Proiect fila. Aceasta vă va afișa toate schițele active.
  3. De aici, puteți face clic pe o schiță existentă pentru a o deschide. Pentru a crea o schiță nouă, faceți clic pe Noua cerere de modificare și așteptați ca pagina să se termine încărcarea.
  4. În panoul de jos, faceți clic pe Introduceți un subiect . Aceasta va deschide o fereastră în care puteți da un nume noii schițe. De exemplu, Pagina nouă - Cum se configurează Codebase .

Cum se creează pagini și grupuri

Odată ce aveți o schiță, puteți începe să faceți modificări în documentație. GitBook stochează modificările dvs. în versiunea nefinalizată, astfel încât acestea să nu afecteze copia principală. Puteți folosi bara laterală din stânga pentru a adăuga pagini și grupuri de pagini.





  1. Creați o pagină nouă făcând clic pe Pagina noua link din partea de jos a barei laterale și selectând Noua pagină de document din meniul derulant. Alternativ, puteți plasa cursorul pe sub o pagină existentă și faceți clic pe albastru la care se adauga buton.
  2. Pentru a crea un nou grup de pagini, faceți clic pe Pagina noua , și selectați Grup nou opțiunea din meniul derulant.
  3. Puteți redenumi pagina făcând clic pe cele trei puncte de lângă pagină sau grup și selectând Redenumiți .
  4. Începeți să adăugați conținut pentru a vă completa noua pagină. Puteți adăuga conținut simplu, cum ar fi text sau titluri. GitBook vă permite, de asemenea, să adăugați și alte blocuri de conținut, cum ar fi imagini, fișiere atașate, tabele, file sau fragmente de cod. Există, de asemenea, opțiunea de a adăuga alte integrări, cum ar fi încorporarea YouTube sau conținutul Google Docs.
  5. Faceți clic pe Vedere diferită butonul din panoul de jos pentru a vedea diferențele dintre schița și copia originală a documentației master.
  6. După ce ați terminat de scris conținutul, puteți da clic pe Combina , Trimiteți și îmbinați , sau Trimiteți pentru revizuire .

Puteți accesa linkul de partajare din panoul de sus al GitBook. Pentru a putea vedea linkul, va trebui să nu mai aveți o versiune nefinalizată și să vizualizați copia documentației principale.

  1. În mod implicit, vizibilitatea site-ului dvs. de documentare este „nelistată”. Aceasta înseamnă că puteți accesa site-ul de documentare folosind un link privat, și nu prin motoarele de căutare. În panoul de sus, faceți clic pe Nelistate buton.
  2. Selectați setările de vizibilitate dorite din meniul drop-down. Rețineți că GitBook poate bloca anumite setări de vizibilitate și poate fi necesar să faceți upgrade pentru a le accesa.
  3. Sub lista setărilor de vizibilitate, există un link pe care îl puteți partaja cu alți utilizatori care vor folosi site-ul dvs. de documentare. Copiați acest link pentru a-l partaja altora.
  4. Sub link, dați clic pe Setări link și domeniu . Aici puteți conecta un nume de domeniu personalizat sau puteți modifica o parte a adresei URL. Dacă utilizați un domeniu personalizat, puteți vizualiza Documentația Gitbook-ului despre cum să vă configurați corect DNS-ul.

Crearea documentației folosind GitBook

GitBook vă permite să creați și să lucrați în colaborare pe site-uri de documentare sau wiki-uri ale companiei. GitBook împrumută concepte de la GitHub, cum ar fi ramuri și fuziune pentru a controla o copie master și a gestiona orice conflicte.

Puteți crea o nouă schiță pentru a adăuga propriile modificări individuale la documentație. În cadrul schiței, puteți face modificări conținutului, precum și puteți adăuga pagini noi sau grupuri de pagini. După ce ați terminat de efectuat modificările, puteți fie să le îmbinați, fie să le trimiteți spre examinare.

eroare netflix avf 11800 os 42803

Dacă creați documentație internă pentru codul Java, poate doriți să explorați Javadoc. Javadoc vă permite să vă documentați automat codul Java.