GitBook on alusta, jonka avulla sinä ja tiimisi voit luoda dokumentaatiosivustoja ja tehdä yhteistyötä niiden kanssa. GitBook tekee tämän käyttämällä versionhallintakonsepteja, kuten haarautumista ja yhdistämistä.

Koska monet tiimin jäsenet voivat työskennellä yhdellä dokumentaatiosivustolla, GitBookin avulla voit luoda ja hallita erillisiä luonnoksia. Voit myös tarkastella eroja nykyisen luonnoksesi ja alkuperäisen dokumentaatiokopion välillä.

Voit lisätä wikisivuillesi useita erilaisia ​​lohkoja. Tämä sisältää otsikot, kappaleet, kuvat, vihjeet, taulukot, koodilohkot, tiedostoliitteet ja paljon muuta.

Sisältölohkojen lisääminen GitBookiin

Voit tarkastella luetteloa käytettävissä olevista sivulle lisättävistä sisältölohkoista. Voit tehdä tämän napsauttamalla mitä tahansa sivun kohtaa ja napsauttamalla plus ilmestyvä symboli. Voit myös etsiä suoraan tiettyä sisältölohkoa.

Voit lisätä sisältöä Markdownin avulla. Jos et ole aiemmin käyttänyt Markdownia, voit lukea lisää kuinka pääset alkuun Markdownin kanssa. Voit myös lukea lisää aiheesta miksi Markdown on niin suosittu.

instagram viewer

Kappaleiden, luetteloiden, lainausten tai koodilohkojen lisääminen

Jos haluat lisätä luetteloita, kappaleita, lainauksia, koodilohkoja tai muita yksinkertaisia ​​sisältölohkoja, avaa pudotusvalikko ja valitse käytettävissä olevista tyypeistä.

  1. Napsauta dokumentaatiosivustosi sivulla -kuvaketta plus -painiketta kohdassa, johon haluat lisätä sisältösi.
  2. Avattavasta valikosta voit selata luetteloa nähdäksesi eri sisältövaihtoehdot.
  3. Valitse tästä mikä tahansa yksinkertainen sisältötyyppi, kuten kappale, koodilohko, otsikko tai lainaus. GitBook muuttaa sisällön automaattisesti vastaamaan valitsemaasi muotoa.

Kuvien tai liitetiedostojen lisääminen

Voit lisätä kuvia valitsemalla avattavasta valikosta Kuvat sisältölohkovaihtoehto. Jos haluat lisätä tiedostoja, valitse Lisää tiedostot vaihtoehto sen sijaan. Voit sitten käyttää oikeanpuoleista paneelia ladattujen kuvien ja tiedostojen hallintaan.

  1. Avaa sivu dokumentaatiosivustollasi. Klikkaa plus -painiketta avataksesi käytettävissä olevien sisältölohkojen pudotusvalikon.
  2. Valitse Lisää kuvia.
  3. Näyttöön tulevassa oikeanpuoleisessa paneelissa on kolme välilehteä. The Tiedostot -välilehden avulla voit ladata oman kuvatiedoston. The URL-osoite -välilehden avulla voit linkittää kuvaan verkossa. Voit myös avata Poista roiskeet -välilehti. Täältä voit valita olemassa olevia kuvia, jotka eivät vaadi tekijän merkintää.
  4. Kun olet lisännyt kuvan, napsauta kolme pistettä -painiketta, joka sijaitsee kuvan vasemmassa yläkulmassa. Tämä avaa pudotusvalikon, jossa voit tasata kuvan tai poistaa sen. Voit myös antaa kuvalle kuvatekstin.
  5. Lisää tiedostoja asettamalla kohdistin minne tahansa dokumentaatiosivustosi sivulla. Klikkaa plus -painiketta avataksesi sisältölohkotyyppien avattavan valikon. Napsauta tällä kertaa lisää tiedostoja vaihtoehto.
  6. Samanlainen oikeanpuoleinen paneeli tulee näkyviin, jolloin voit ladata minkä tahansa liitetiedoston kuvan sijaan. Klikkaa Selaa tiedostoja valitaksesi paikallisesti tietokoneellesi tallennetun tiedoston.
  7. Tiedosto tulee näkyviin luetteloon. Napsauta tiedostoa, ja GitBook luo sisältölohkon tiedostoliitteellä avaamallesi sivulle. Napsauttamalla tätä sisältölohkoa ladataan liitetiedosto.

Kuinka lisätä vinkkejä

Voit myös lisätä vihjeitä sivullesi. Voit muuttaa vihjeiden kuvakkeen käyttämään punaista vaaraa, oranssia varoitusta varten, sinistä tietoa tai vihreää onnistumista varten.

  1. Lisää vihje napsauttamalla plus -painiketta avataksesi käytettävissä olevien sisältölohkojen pudotusvalikon.
  2. Valitse Vihje.
  3. Tämä lisää vihjeen sivullesi. Oletusarvoisesti vihjetyyppi on "tiedot", ja se sisältää sinisen kuvakkeen.
  4. Voit vaihtaa vihjeen tyyppiä napsauttamalla kuvaketta. Tämä käy läpi neljä erilaista vihjetyyppiä.

Kuinka lisätä taulukoita

Voit lisätä taulukoita valitsemalla pöytä vaihtoehto avattavasta luettelosta. Kun taulukko on sivulla, voit lisätä uusia rivejä tai sarakkeita. Voit myös muokata sarakkeiden nimiä ja tietotyyppejä sekä muuttaa tietoja taulukon sisällä.

  1. Klikkaa plus -painiketta avataksesi käytettävissä olevien sisältölohkojen pudotusvalikon.
  2. Valitse Pöytä.
  3. Napsauta taulukon sarakkeen otsikkoa. Tämä avaa uuden pienemmän valikon, jossa voit muuttaa valitun sarakkeen nimeä. Tämän valikon avulla voit myös poistaa tai piilottaa valitun sarakkeen. Tietyissä saraketietotyypeissä voit myös tasata sisällön sarakkeen sisällä.
  4. Oletuksena sarakkeiden tietotyypiksi on valittu "Teksti". Napsauta painiketta T symboli muuttaaksesi tietotyyppiä. Voit muuttaa sen numeroksi, valintaruuduksi, avattavaksi valikoksi, liitetiedostoksi, arvosanaksi tai muuksi.
  5. Klikkaa kuuden pisteen kuvake lähellä pöydän vasenta yläkulmaa. Täällä voit lisätä uusia sarakkeita ja rivejä tai poistaa koko taulukon. Voit myös piilottaa tai näyttää tietyt sarakkeet tai muuttaa muita taulukon ominaisuuksia.

Sivulinkkilohkojen lisääminen

Sivulinkkilohkot ovat linkkejä, jotka kattavat koko sivun rivin. Kun lisäät linkin, sinun on linkitettävä sivulle, joka avautuu, kun joku napsauttaa sitä.

  1. Klikkaa plus -painiketta avataksesi käytettävissä olevien sisältölohkojen pudotusvalikon.
  2. Klikkaa Sivun linkki.
  3. Valitse uudesta avattavasta valikosta sivu, johon linkität.
  4. Sivusi linkki näkyy sivulla olevan lohkon sisällä.

GitBookin käyttö dokumentointiin

GitBook on dokumentaatiotyökalu, joka käyttää versionhallintakonsepteja, kuten haaroittelua ja yhdistämistä. Näin useampi kuin yksi tiimin jäsen voi työskennellä dokumentaation parissa samanaikaisesti. Se auttaa myös hallitsemaan mahdollisia konflikteja.

Voit lisätä sivulle kaikenlaisia ​​sisältölohkoja. Voit muotoilla sisältöä uudelleen otsikoiden, kappaleiden, koodilohkojen tai luettelomerkkien avulla. Voit muuttaa vihjeiden vihjetyyppiä, viesti- ja kuvaketyyppiä sekä mukauttaa taulukon sarakkeita.

Tiedostot-välilehden avulla voit hallita sivustolle lataamiasi kuvia ja tiedostoliitteitä. Sivulinkkien avulla voit luoda suuria linkkejä, jotka käyttäjät voivat helposti havaita.

Jos olet luomassa Go-kieleen liittyvää dokumentaatiota, voit käyttää Godocia. Godocin avulla voit automaattisesti dokumentoida Go-koodisi.