Home-theater-designers
GitBook on alusta, jonka avulla voit rakentaa dokumentaatiosivustoja tai yrityswikejä. Voit käyttää sitä dokumentoimaan kaikenlaisia asioita koodista API:ihin ja ohjelmistotuotteen käyttöön.
GitBook käyttää samanlaista prosessia kuin GitHub-arkistot. Asiakirjan pääkopio toimii 'peruskopiona'. Voit sitten luoda 'luonnoksia', jotka ovat samanlaisia kuin 'oksat'.
Tämän prosessin avulla monet käyttäjät voivat työskennellä yhdessä dokumentaatiosivustossa ja samalla käsitellä tai estää ristiriitoja. Se sallii myös eri haarojen muutosten käydä läpi tarkistusprosessin ennen niiden yhdistämistä.
Kuinka aloittaa GitBookin käyttö
Voit valita useista GitBookin hinnoittelu suunnitelmia. Hinnoittelu riippuu siitä, käytätkö GitBookia avoimen lähdekoodin projekteihin, henkilökohtaiseen käyttöön vai yksityiseen tiimiyhteistyöhön. GitBook on ilmainen käyttää, jos käytät sitä avoimen lähdekoodin projekteihin.
kuinka saada Windows 10 näyttämään paremmalta
GitBook tukee Markdown, suosittu merkintäkieli, jolla on monia etuja kirjoittamista tai dokumentointia varten verkossa.
GitBook integroituu myös GitHub, alusta koodin isännöintiin, tallentamiseen ja muokkaamiseen . Voit linkittää GitBook-tilisi suoraan GitHub-tiliisi kirjautumalla sisään GitHub-tunnuksillasi.
- Rekisteröidy GitBookiin. Jos sinulla on oma GitHub-tili, voit napsauttaa Rekisteröidy GitHubilla .
- Kun olet kirjautunut sisään, GitBook ohjaa sinut uuteen sisäiseen wikiin. Se myös esitäyttää wikisi näytesisällöllä.
Yleiskatsaus GitBookin käyttöliittymästä
GitBookissa on useita toimintoja, joiden avulla voit rakentaa dokumentaatiosivustoasi ja tehdä siihen muutoksia.
kuinka asentaa sovelluksia vizio tv: hen
- Yläpaneelin avulla voit luoda uusia luonnoksia, tarkastella muutoshistoriaa tai tarkastella muita keskusteluja tai liitteitä.
- Vasemmanpuoleisen sivupalkin avulla voit luoda useita välilyöntejä. Voit käyttää erillisiä tiloja eri projekteille, jotta voit erottaa ja järjestää dokumentaatioalueesi. Voit laajentaa tai sulkea sivupalkin.
- Vasen paneeli toimii dokumentaatiosivuston valikkona. Voit tarkastella dokumentaatiosivustosi sivuja ja käyttää sitä ryhmien ja sisäkkäisten sivujen luomiseen. Voit myös selata sivustoa käyttämällä annettuja linkkejä.
- Alapaneelissa on painikkeita, jotka ovat tärkeitä versionhallintaprosessille. Voit lisätä luonnokselle nimen, yhdistää muutoksen tai lähettää muutoksen tarkistettavaksi.
Kuinka luoda uusi luonnos
Voit luoda uuden luonnoksen luomalla uuden muutospyynnön ja tekemällä muutoksia siihen.
- Napsauta yläpaneelissa Muutospyynnöt .
- Napsauta uudessa paneelissa, joka tulee näkyviin oikealle puolelle Luonnos -välilehti. Tämä näyttää sinulle kaikki aktiiviset luonnoksesi.
- Täältä voit avata olemassa olevan luonnoksen napsauttamalla sitä. Luo uusi luonnos napsauttamalla Uusi muutospyyntö ja odota, että sivu latautuu loppuun.
- Napsauta alapaneelissa Anna aihe . Tämä avaa ikkunan, jossa voit antaa uudelle luonnokselle nimen. Esimerkiksi, Uusi sivu - Koodikannan määrittäminen .
Sivujen ja ryhmien luominen
Kun sinulla on luonnos, voit alkaa tehdä muutoksia dokumentaatioon. GitBook tallentaa tekemäsi muutokset luonnokseen, joten ne eivät vaikuta alkuperäiseen kopioon. Voit lisätä sivuja ja sivuryhmiä vasemman sivupalkin avulla.
- Luo uusi sivu napsauttamalla Uusi sivu linkki sivupalkin alareunassa ja valitse Uusi asiakirjasivu pudotusvalikosta. Vaihtoehtoisesti voit viedä hiiren olemassa olevan sivun alle ja napsauttaa sinistä plus -painiketta.
- Luo uusi sivuryhmä napsauttamalla Uusi sivu ja valitse Uusi ryhmä vaihtoehto pudotusvalikosta.
- Voit nimetä sivun uudelleen napsauttamalla sivun tai ryhmän vieressä olevaa kolmea pistettä ja valitsemalla Nimeä uudelleen .
- Aloita sisällön lisääminen uudelle sivullesi. Voit lisätä yksinkertaista sisältöä, kuten tekstiä tai otsikoita. GitBookin avulla voit myös lisätä muita sisältölohkoja, kuten kuvia, tiedostoliitteitä, taulukoita, välilehtiä tai koodinpätkiä. On myös mahdollisuus lisätä muita integraatioita, kuten YouTube-upotuksia tai Google-dokumenttien sisältöä.
- Klikkaa Erilainen näkymä -painiketta alapaneelissa nähdäksesi erot luonnoksesi ja alkuperäisen dokumentaatiokopion välillä.
- Kun olet kirjoittanut sisällön, voit napsauttaa Yhdistää , Lähetä ja yhdistä , tai Lähetä tarkistettavaksi .
Linkin luominen dokumentaatiosivustolle
Pääset jakamislinkkiin GitBookin yläpaneelista. Sinun on oltava poissa luonnoksesta ja katsottava asiakirjan peruskopiota, jotta voit tarkastella linkkiä.
ilmainen wifi -soittosovellus androidille
- Oletuksena dokumentaatiosivustosi näkyvyys on 'pitämätön'. Tämä tarkoittaa, että pääset dokumentaatiosivustolle yksityisen linkin kautta, et hakukoneiden kautta. Napsauta yläpaneelissa Piilotettu -painiketta.
- Valitse haluamasi näkyvyysasetukset avattavasta valikosta. Huomaa, että GitBook saattaa lukita tietyt näkyvyysasetukset, ja sinun on ehkä päivitettävä päästäksesi niihin.
- Näkyvyysasetusten luettelon alla on linkki, jonka voit jakaa muille käyttäjille, jotka käyttävät dokumentaatiosivustoasi. Kopioi tämä linkki jakaaksesi sen muiden kanssa.
- Klikkaa linkin alta Linkki- ja verkkotunnuksen asetukset . Täällä voit linkittää mukautetun verkkotunnuksen nimen tai muokata osaa URL-osoitteesta. Jos käytät mukautettua verkkotunnusta, voit tarkastella Gitbookin dokumentaatio kuinka määrittää DNS oikein.
Dokumentaation luominen GitBookilla
GitBookin avulla voit yhdessä luoda ja työskennellä dokumentaatiosivustoilla tai yrityksen wikeillä. GitBook lainaa GitHubista konsepteja, kuten oksia ja yhdistämistä hallitakseen pääkopiota ja hallitakseen mahdollisia ristiriitoja.
Voit luoda uuden luonnoksen lisätäksesi omia yksittäisiä muutoksiasi dokumentaatioon. Luonnoksessa voit tehdä muutoksia sisältöön sekä lisätä uusia sivuja tai sivuryhmiä. Kun olet tehnyt muutokset, voit joko yhdistää ne tai lähettää ne tarkistettavaksi.
Jos olet luomassa sisäistä dokumentaatiota Java-koodillesi, sinun kannattaa tutustua Javadociin. Javadocin avulla voit dokumentoida Java-koodisi automaattisesti.