GitBook on platvorm, mis võimaldab teil ja teie meeskonnal dokumentatsioonisaite luua ja nendega koostööd teha. GitBook teeb seda versioonihalduskontseptsioonide abil, nagu hargnemine ja ühendamine.

Kuna paljud meeskonnaliikmed saavad töötada ühel dokumentatsiooni saidil, võimaldab GitBook luua ja hallata eraldi mustandeid. Samuti saate vaadata erinevusi praeguse mustandi ja põhidokumentatsiooni koopia vahel.

Vikilehtedele lisamiseks on saadaval mitut tüüpi plokke. See hõlmab pealkirju, lõike, pilte, vihjeid, tabeleid, koodiplokke, failimanuseid ja palju muud.

Kuidas GitBookis sisuplokke lisada

Saate vaadata lehele lisamiseks saadaolevate sisuplokkide loendit. Seda saate teha, klõpsates lehel suvalises kohas ja klõpsates nuppu pluss kuvatav sümbol. Samuti saate otse otsida konkreetset sisuplokki.

Sisu saate lisada Markdowni abil. Kui te pole Markdowni varem kasutanud, saate selle kohta lisateavet kuidas Markdowniga alustada. Samuti saate rohkem lugeda miks Markdown on nii populaarne.

Kuidas lisada lõike, loendeid, tsitaate või koodiplokke

instagram viewer

Loendite, lõikude, tsitaatide, koodiplokkide või muude lihtsate sisuplokkide lisamiseks avage rippmenüü ja valige saadaolevate tüüpide hulgast.

  1. Klõpsake oma dokumentatsiooni saidi lehel nuppu pluss nuppu kohas, kuhu soovite oma sisu lisada.
  2. Rippmenüüst saate erinevate sisuvalikute kuvamiseks loendit sirvida.
  3. Valige siit mis tahes lihtne sisutüüp, näiteks lõik, koodiplokk, pealkiri või tsitaat. GitBook muudab sisu automaatselt teie valitud vormingule vastavaks.

Kuidas lisada pilte või failimanuseid

Piltide lisamiseks kasutage rippmenüüd, et valida Pildid sisuploki valik. Failide lisamiseks valige Sisesta failid selle asemel variant. Seejärel saate oma üleslaaditud piltide ja failide haldamiseks kasutada parempoolset paneeli.

  1. Avage oma dokumentatsiooni saidil leht. Klõpsake nuppu pluss nuppu, et avada saadaolevate sisuplokkide rippmenüü.
  2. Valige Sisesta pilte.
  3. Ilmuval parempoolsel paneelil on kolm vahekaarti. The Failid vahekaart võimaldab teil oma pildifaili üles laadida. The URL vahekaart võimaldab teil võrgus pildi linkida. Samuti saate avada Eemaldage pritsmed sakk. Siin saate valida olemasolevaid fotosid, mis ei vaja omistamist.
  4. Kui olete pildi lisanud, klõpsake nuppu kolm punkti nupp, mis asub pildi vasakus ülanurgas. See avab rippmenüü, kus saate pildi joondada või kustutada. Saate pildile ka pealkirja anda.
  5. Failide sisestamiseks asetage kursor dokumentatsioonisaidi lehel ükskõik kuhu. Klõpsake nuppu pluss nuppu sisuploki tüüpide rippmenüü avamiseks. Seekord klõpsake nuppu failide sisestamine valik.
  6. Ilmub sarnane parempoolne paneel, mis võimaldab teil pildi asemel üles laadida mis tahes failimanuse. Kliki Sirvige faile arvutisse lokaalselt salvestatud faili valimiseks.
  7. Fail kuvatakse loendis. Klõpsake failil ja GitBook loob teie avatud lehel failimanusega sisuploki. Sellel sisuplokil klõpsates laaditakse failimanus alla.

Kuidas lisada vihjeid

Samuti saate oma lehele vihjeid lisada. Saate muuta vihjete ikooni nii, et see kasutaks ohu tähistamiseks punast, hoiatuseks oranži, teabe jaoks sinist või edu saavutamiseks rohelist.

  1. Vihje lisamiseks klõpsake nuppu pluss nuppu, et avada saadaolevate sisuplokkide rippmenüü.
  2. Valige Vihje.
  3. See lisab teie lehele vihje. Vaikimisi on vihje tüüp "teave" ja sisaldab sinist ikooni.
  4. Vihje tüüpi saate muuta ikoonil klõpsates. See liigub läbi nelja erineva vihjetüübi.

Kuidas tabeleid lisada

Saate lisada tabeleid, valides laud valik rippmenüüst. Kui tabel on lehel, saate lisada uusi ridu või veerge. Samuti saate muuta veergude nimesid ja andmetüüpe ning muuta tabelis olevaid andmeid.

  1. Klõpsake nuppu pluss nuppu, et avada saadaolevate sisuplokkide rippmenüü.
  2. Valige Tabel.
  3. Klõpsake tabelis veeru päisel. See avab uue väiksema menüü, kus saate valitud veeru nime muuta. See menüü võimaldab ka valitud veeru kustutada või peita. Teatud veeru andmetüüpide puhul saate sisu joondada ka veeru sees.
  4. Vaikimisi on veergude jaoks valitud andmetüüp "Tekst". Klõpsake nupul T sümbol andmetüübi muutmiseks. Saate seda muuta numbriks, märkeruuduks, rippmenüüks, failimanuseks, hinnanguks või muuks.
  5. Klõpsake nuppu kuue punktiga ikoon tabeli vasaku ülanurga lähedal. Siin saate lisada uusi veerge ja ridu või kustutada kogu tabeli. Samuti saate teatud veerge peita või kuvada või muuta tabeli muid atribuute.

Lehekülje linkide plokkide lisamine

Lehekülje lingiplokid on lingid, mis hõlmavad kogu lehel oleva rea. Lingi lisamisel tuleb linkida lehele, mis avaneb, kui keegi sellel klõpsab.

  1. Klõpsake nuppu pluss nuppu, et avada saadaolevate sisuplokkide rippmenüü.
  2. Kliki Lehekülje link.
  3. Valige uuest rippmenüüst leht, millele lingite.
  4. Teie lehe link kuvatakse lehel plokis.

GitBooki kasutamine dokumenteerimiseks

GitBook on dokumentatsioonitööriist, mis kasutab versioonihalduse kontseptsioone, nagu hargnemine ja ühendamine. See võimaldab dokumentatsiooni kallal töötada korraga rohkem kui ühel meeskonnaliikmel. Samuti aitab see lahendada tekkinud konflikte.

Lehele saab lisada igasuguseid sisuplokke. Sisu ümbervormindamiseks saate kasutada pealkirju, lõike, koodiplokke või täppe. Saate muuta vihjete tüüpi, sõnumit ja ikoonitüüpi, samuti kohandada tabeli veerge.

Vahekaart Failid võimaldab hallata saidile üleslaaditud pilte ja failimanuseid. Lehekülje lingid võimaldavad teil luua suuri linke, mida kasutajad saavad hõlpsasti märgata.

Kui loote Go keelega seotud dokumentatsiooni, saate kasutada Godoci. Godoc võimaldab teil oma Go koodi automaatselt dokumenteerida.