Kuidas luua Gitbooki abil lihtsat sisemist Wiki

Kuidas luua Gitbooki abil lihtsat sisemist Wiki

GitBook on platvorm, mis võimaldab teil luua dokumentatsioonisaite või ettevõtte vikisid. Saate seda kasutada igasuguste asjade dokumenteerimiseks, alates koodist kuni API-de ja tarkvaratoote kasutamiseni.





GitBook kasutab sarnast protsessi kui GitHubi hoidlad. Dokumentatsiooni põhikoopia toimib 'põhikoopiana'. Seejärel saate luua 'mustandeid', mis on sarnased 'harudega'.



See protsess võimaldab paljudel kasutajatel töötada ühel dokumentatsiooni saidil, käsitsedes või ennetades konflikte. Samuti võimaldab see erinevate harude muudatused enne nende ühendamist läbi vaadata.





Kuidas alustada GitBooki kasutamist

Valida saab mitme hulgast GitBooki hinnakujundus plaanid. Hinnakujundus sõltub sellest, kas kasutate GitBooki avatud lähtekoodiga projektide jaoks, isiklikuks kasutamiseks või erameeskonna koostööks. GitBooki kasutamine on tasuta, kui kasutate seda avatud lähtekoodiga projektide jaoks.

GitBook toetab Markdown, populaarne märgistuskeel, millel on palju eeliseid veebis kirjutamiseks või dokumenteerimiseks.



galaxy s21 vs iphone 12 pro

GitBook integreerub ka GitHub, platvorm koodi hostimiseks, salvestamiseks ja redigeerimiseks . Saate linkida oma GitBooki konto otse oma GitHubi kontoga, logides sisse oma GitHubi mandaati kasutades.

  1. Registreeruge GitBookis. Kui teil on oma GitHubi konto, võite klõpsata Registreeruge GitHubiga .
  2. Kui olete sisse loginud, suunab GitBook teid uude sisemisse wiki. Samuti täidab see teie wiki näidissisuga.

GitBooki liidese ülevaade

GitBookil on mitu funktsiooni, mis võimaldavad teil dokumentatsiooni saiti luua ja seal muudatusi teha.



  1. Ülemine paneel võimaldab teil luua uusi mustandeid, vaadata muudatuste ajalugu või vaadata muid arutelusid või manuseid.
  2. Vasakpoolseim külgriba võimaldab teil luua mitu tühikut. Saate kasutada erinevate projektide jaoks eraldi ruume, et saaksite dokumentatsioonialasid eraldada ja korraldada. Saate külgriba laiendada või sulgeda.
  3. Vasak paneel toimib dokumentatsiooni saidi menüüna. Saate vaadata oma dokumentatsiooni saidi lehti ning kasutada seda rühmade ja pesastatud lehtede loomiseks. Saate saidil navigeerida ka pakutavate linkide abil.
  4. Alumine paneel sisaldab nuppe, mis on versioonihaldusprotsessi jaoks üliolulised. Saate oma mustandile nime lisada, muudatuse liita või muudatuse ülevaatamiseks esitada.

Kuidas luua uut mustandit

Saate luua uue mustandi, luues uue muudatustaotluse ja tehes selles muudatusi.

  1. Klõpsake ülemisel paneelil nuppu Muudatustaotlused .
  2. Paremal pool ilmuval uuel paneelil klõpsake Mustand sakk. See näitab teile kõiki teie aktiivseid mustandeid.
  3. Siin saate klõpsata olemasoleval mustandil, et see avada. Uue mustandi loomiseks klõpsake nuppu Uus muudatustaotlus ja oodake, kuni lehe laadimine lõpeb.
  4. Klõpsake alumisel paneelil nuppu Sisestage teema . See avab akna, kus saate uuele mustandile nime anda. Näiteks, Uus leht – koodibaasi seadistamine .

Kuidas luua lehti ja rühmi

Kui teil on mustand, võite hakata dokumentatsiooni muutma. GitBook salvestab teie muudatused mustandi sisse, nii et need ei mõjuta põhikoopiat. Lehtede ja leherühmade lisamiseks saate kasutada vasakpoolset külgriba.



  1. Looge uus leht, klõpsates nuppu Uus leht link külgriba allservas ja valides Uus dokumendi leht rippmenüüst. Teise võimalusena võite hõljutada kursorit olemasoleva lehe all ja klõpsata sinisel pluss nuppu.
  2. Uue leherühma loomiseks klõpsake nuppu Uus leht ja valige Uus grupp valik rippmenüüst.
  3. Saate lehe ümber nimetada, klõpsates lehe või rühma kõrval oleval kolmel punktil ja valides Nimeta ümber .
  4. Alustage uue lehe täitmiseks sisu lisamist. Saate lisada lihtsat sisu, näiteks teksti või pealkirju. GitBook võimaldab lisada ka muid sisuplokke, näiteks pilte, failimanuseid, tabeleid, vahelehti või koodijuppe. Samuti on võimalik lisada muid integratsioone, nagu YouTube'i manused või Google Docsi sisu.
  5. Klõpsake nuppu Erinev vaade nuppu allpaneelil, et näha erinevusi mustandi ja originaaldokumendi koopia vahel.
  6. Kui olete sisu kirjutamise lõpetanud, võite klõpsata Ühendage , Esitage ja ühendage , või Esitage ülevaatamiseks .

Jagamislingile pääsete juurde GitBooki ülemiselt paneelilt. Lingi vaatamiseks peate olema mustandist väljas ja nägema põhidokumentatsiooni koopiat.

  1. Vaikimisi on teie dokumentatsioonisaidi nähtavus 'loendeerimata'. See tähendab, et pääsete dokumentatsiooni saidile juurde privaatse lingi, mitte otsingumootorite kaudu. Klõpsake ülemisel paneelil nuppu Registreerimata nuppu.
  2. Valige rippmenüüst soovitud nähtavuse seaded. Pange tähele, et GitBook võib teatud nähtavuse seaded lukustada ja nendele juurdepääsuks peate võib-olla uuendama.
  3. Nähtavuse seadete loendi all on link, mida saate jagada teiste kasutajatega, kes kasutavad teie dokumentatsiooni saiti. Kopeerige see link, et seda teistega jagada.
  4. Klõpsake lingi all Lingi ja domeeni seaded . Siin saate linkida kohandatud domeeninime või muuta osa URL-ist. Kui kasutate kohandatud domeeni, saate vaadata Gitbooki dokumentatsioon kuidas oma DNS-i õigesti konfigureerida.

Dokumentatsiooni loomine GitBooki abil

GitBook võimaldab teil ühiselt luua dokumentatsioonisaite või ettevõtte vikisid ja nendega töötada. GitBook laenab GitHubist selliseid kontseptsioone nagu harud ja liitmised, et juhtida põhikoopiat ja hallata konflikte.

Saate luua uue mustandi, et lisada dokumentatsiooni oma individuaalsed muudatused. Mustandis saate teha sisus muudatusi, samuti lisada uusi lehti või leherühmi. Kui olete muudatuste tegemise lõpetanud, saate need liita või ülevaatamiseks esitada.

Windows 10 automaatne remont ei tööta

Kui loote oma Java-koodi jaoks sisedokumentatsiooni, võiksite uurida Javadoci. Javadoc võimaldab teil oma Java koodi automaatselt dokumenteerida.