GitBook ir platforma, kas ļauj jums un jūsu komandai izveidot dokumentācijas vietnes un sadarboties tajās. GitBook to dara, izmantojot versiju kontroles koncepcijas, piemēram, sazarošanu un apvienošanu.
Tā kā daudzi komandas locekļi var strādāt vienā dokumentācijas vietnē, GitBook ļauj izveidot un pārvaldīt atsevišķus melnrakstus. Varat arī skatīt atšķirības starp pašreizējo melnrakstu un pamatdokumentācijas kopiju.
Ir pieejami vairāki bloku veidi, ko pievienot savām wiki lapām. Tas ietver virsrakstus, rindkopas, attēlus, padomus, tabulas, kodu blokus, failu pielikumus un daudz ko citu.
Kā pievienot satura blokus GitBook
Varat apskatīt pieejamo satura bloku sarakstu, ko pievienot lapai. To var izdarīt, noklikšķinot jebkurā lapas vietā un noklikšķinot uz plus parādās simbols. Varat arī tieši meklēt noteiktu satura bloku.
Varat pievienot saturu, izmantojot Markdown. Ja iepriekš neesat izmantojis Markdown, varat uzzināt vairāk par kā sākt darbu ar Markdown. Varat arī lasīt vairāk par kāpēc Markdown ir tik populārs.
Kā pievienot rindkopas, sarakstus, citātus vai kodu blokus
Lai pievienotu sarakstus, rindkopas, citātus, kodu blokus vai citus vienkāršus satura blokus, atveriet nolaižamo izvēlni un atlasiet kādu no pieejamajiem veidiem.
- Dokumentācijas vietnes lapā noklikšķiniet uz plus pogu vietā, kur vēlaties pievienot savu saturu.
- Nolaižamajā izvēlnē varat ritināt sarakstu, lai skatītu dažādas satura opcijas.
- Šeit atlasiet jebkuru vienkāršu satura veidu, piemēram, rindkopu, koda bloku, virsrakstu vai citātu. GitBook automātiski mainīs saturu, lai tas atbilstu jūsu atlasītajam formātam.
Kā pievienot attēlus vai failu pielikumus
Lai pievienotu attēlus, izmantojiet nolaižamo izvēlni, lai atlasītu Attēli satura bloka opcija. Lai pievienotu failus, atlasiet Ievietot failus opciju vietā. Pēc tam varat izmantot labās puses paneli, lai pārvaldītu augšupielādētos attēlus un failus.
- Atveriet lapu savā dokumentācijas vietnē. Noklikšķiniet uz plus pogu, lai atvērtu pieejamo satura bloku nolaižamo izvēlni.
- Izvēlieties Ievietot attēlus.
- Parādītajā labajā panelī ir trīs cilnes. The Faili cilne ļauj augšupielādēt savu attēla failu. The URL cilne ļauj izveidot saiti uz attēlu tiešsaistē. Varat arī atvērt Atbrīvojieties no šļakatām cilne. Šeit varat atlasīt esošos fotoattēlus, kuriem nav nepieciešams attiecinājums.
- Kad esat pievienojis attēlu, noklikšķiniet uz trīs punkti pogu, kas atrodas attēla augšējā kreisajā stūrī. Tiks atvērta nolaižamā izvēlne, kurā varēsiet līdzināt attēlu vai dzēst to. Varat arī pievienot attēlam parakstu.
- Lai ievietotu failus, novietojiet kursoru jebkurā dokumentācijas vietnes lapā. Noklikšķiniet uz plus pogu, lai atvērtu satura bloku veidu nolaižamo izvēlni. Šoreiz noklikšķiniet uz ievietot failus opciju.
- Tiks parādīts līdzīgs labās puses panelis, kas ļaus attēla vietā augšupielādēt jebkuru faila pielikumu. Klikšķiniet uz Pārlūkojiet failus lai atlasītu datorā lokāli saglabātu failu.
- Fails parādīsies sarakstā. Noklikšķiniet uz faila, un GitBook jūsu atvērtajā lapā izveidos satura bloku ar faila pielikumu. Noklikšķinot uz šī satura bloka, tiks lejupielādēts faila pielikums.
Kā pievienot padomus
Varat arī savai lapai pievienot padomus. Varat mainīt ieteikumu ikonu, lai izmantotu sarkanu krāsu, lai brīdinātu, oranžu brīdinājumu, zilu informāciju vai zaļu, lai gūtu panākumus.
- Lai pievienotu mājienu, noklikšķiniet uz plus pogu, lai atvērtu pieejamo satura bloku nolaižamo izvēlni.
- Izvēlieties Padoms.
- Tas jūsu lapai pievienos mājienu. Pēc noklusējuma mājiena veids ir “informācija”, un tajā ir zila ikona.
- Padoma veidu var mainīt, noklikšķinot uz ikonas. Tādējādi tiks apskatīti četri dažādi mājienu veidi.
Kā pievienot tabulas
Tabulas var pievienot, atlasot tabula opciju nolaižamajā sarakstā. Kad tabula ir pieejama lapā, varat pievienot jaunas rindas vai kolonnas. Varat arī mainīt kolonnu nosaukumus un datu tipus, kā arī mainīt datus tabulā.
- Noklikšķiniet uz plus pogu, lai atvērtu pieejamo satura bloku nolaižamo izvēlni.
- Izvēlieties Tabula.
- Noklikšķiniet uz tabulas kolonnas galvenes. Tiks atvērta jauna mazāka izvēlne, kurā varēsiet mainīt atlasītās kolonnas nosaukumu. Šī izvēlne ļauj arī dzēst vai paslēpt atlasīto kolonnu. Dažiem kolonnu datu veidiem varat arī līdzināt saturu kolonnas iekšpusē.
- Pēc noklusējuma kolonnām atlasītais datu tips ir "Teksts". Noklikšķiniet uz pogas ar T simbols, lai mainītu datu veidu. Varat to mainīt uz numuru, izvēles rūtiņu, nolaižamo izvēlni, faila pielikumu, vērtējumu vai citiem.
- Noklikšķiniet uz sešu punktu ikona netālu no galda augšējā kreisā stūra. Šeit varat ievietot jaunas kolonnas un rindas vai izdzēst visu tabulu. Varat arī paslēpt vai parādīt noteiktas kolonnas vai mainīt citus tabulas rekvizītus.
Kā pievienot lapu saišu blokus
Lapas saišu bloki ir saites, kas aizņem visu lapas rindiņu. Kad pievienojat saiti, jums ir jāsaista uz lapu, kas tiks atvērta, kad kāds uz tās noklikšķinās.
- Noklikšķiniet uz plus pogu, lai atvērtu pieejamo satura bloku nolaižamo izvēlni.
- Klikšķiniet uz Lapas saite.
- Jaunajā nolaižamajā izvēlnē izvēlieties lapu, uz kuru veidojat saiti.
- Jūsu lapas saite parādīsies lapas blokā.
GitBook izmantošana dokumentācijai
GitBook ir dokumentācijas rīks, kas izmanto versiju kontroles koncepcijas, piemēram, sazarošanu un apvienošanu. Tas ļauj vairāk nekā vienam komandas dalībniekam vienlaikus strādāt pie dokumentācijas. Tas arī palīdz pārvaldīt visus radušos konfliktus.
Lapai varat pievienot visa veida satura blokus. Satura pārformatēšanai varat izmantot virsrakstus, rindkopas, kodu blokus vai aizzīmju punktus. Varat mainīt ieteikumu veidu, ziņojumu un ikonu veidu, kā arī pielāgot tabulas kolonnas.
Cilne Faili ļauj pārvaldīt vietnē augšupielādētos attēlus un failu pielikumus. Lapu saites ļauj izveidot lielas saites, kuras lietotāji var viegli pamanīt.
Ja veidojat ar Go valodu saistītu dokumentāciju, varat izmantot Godoc. Godoc ļauj automātiski dokumentēt savu Go kodu.
