GitBook on Node.js-pohjainen komentorivityökalu, joka tukee Markdown- ja AsciiDoc-syntaksimuotoja ja voi tuottaa e-kirjoja HTML-, PDF-, e-kirja- ja muissa muodoissa.
Asenna node.js
Ennen gitbook-työkalun käyttöä tietokoneen täytyy asentaa node.js ympäristö, ja asennuksen jälkeen voit tarkistaa versiokomennon testataksesi, onko asennus onnistunut:
Asenna Gitbook
Gitbook asennetaan npm:llä, komentorivillä:
Suorita alla oleva komento nähdäksesi GitBook-version varmistaaksesi, että asennus onnistui.
Asenna historialliset versiot
gitbook-cli tekee muiden GitBook-versioiden lataamisesta ja asentamisesta helppoa kirjojen testaamiseksi:
Gitbookin käyttö ls-remote luettelee ladattavissa olevat versiot.
Markdown-editori
Tässä käytämme Markdown-syntaksia dokumenttien kirjoituskielenä, meidän täytyy valmistella Markdown-editori, markkinoilla on monia Markdown-editoreita, kuten Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrainsin IDE (vaatii lisäosan asennuksen), Atom, Jianshu, CSDN ja GitBookin oma GitBook Editor ja niin edelleen.
Minulla on VS-koodinkehitystyökalut asennettuna tietokoneelleni, VS Code tukee oletuksena markdownia, minun tarvitsee vain asentaa preview plugin artefakt: Markdown Preview Enhanced, ja aion käyttää sitä!
Ystäväni suosittelema. Toimittaja typora, osoite:Hyperlinkin kirjautuminen on näkyvissä.
Alusta kirja
GitBook voi asettaa vakiolevyn:
Jos haluat luoda kirjan uuteen hakemistoon, voit tehdä sen ajamalla gitbook init ./directory.
Suorituksen jälkeen näet kaksi muuta tiedostoa – README.md ja SUMMARY.md, jotka tekevät seuraavat:
README.md - Kirjan johdanto on kirjoitettu tähän asiakirjaan
SUMMARY.md - Kirjan luettelorakenne on tässä määritelty
En tunne markdown-syntaksia, joten kirjoita vain muutama lause!
Luo staattisia verkkosivuja
Luo staattisia verkkosivuja ja aja palvelimia
Kaikki edellä mainitut tullaan luomaan kirjakatalogiin _book.
Serve-komento voi myös määrittää portin:
Kun luot, määritä gitbookin versio, niin sitä ei ladata ensin paikallisesti
Listaa kaikki paikalliset gitbook-versiot
Listaa etänä saatavilla olevat gitbook-versiot
Asenna vastaava gitbook-versio
Päivitys uusimpaan gitbook-versioon
Poista vastaava gitbook-versio
Määrittelee logaritin tason
Lähtövirheilmoitus
Yhteenveto
GitBook käyttää SUMMARY.md tiedostoja kirjan lukujen ja alalukujen rakenteen määrittämiseen. SUMMARY.md Tiedostoa käytetään kirjan sisällysluettelon luomiseen.
SUMMARY.md muoto on linkkien lista. Linkin otsikko toimii luvun nimenä, ja linkki kohdistuu kyseisen luvun tiedoston polulle.
Lisäämällä sisäkkäisen listan vanhemmaan lukuun syntyy lapsiluku.
Yksinkertainen esimerkki:
Sitten palaamme komentoriville ja suoritamme gitbook init -komennon uudelleen mybook-kansiossa. GitBook etsii hakemistoja ja tiedostoja, jotka kuvataan SUMMARY.md tiedostoissa,Jos ei, se luodaan。
Tulosta PDF-, ePub- tai mobi-tiedostoja
Jos haluat luoda pdf-version, voit ajaa gitbook pdf:ää, samalla tavalla kuin viet epub-muodossa, gitbook epub, jos se on mobi-muodossa, gitbook mobi riittää.
Jos haluat viedä e-kirjan PDF-, ePub- tai mobi-muodossa,Vaatii Calibre eBook Reader/Managerin ja komentorivityökalut, muuten virhe voidaan raportoida "EbookError: Error during ebook generation: 'ebook-convert'".
GitBook Special Filesin ominaisuudet:
tiedosto | kuvaus | | book.json | Konfiguraatiotiedot (valinnainen) | | README.md | Esipuhe tai johdanto e-kirjaan (pakollinen) | | SUMMARY.md | E-kirjaluettelo (valinnainen) | | GLOSSARY.md | Luettelo sanasto/annotaatiotermeistä (valinnainen) |
Gitbookin yleiset asetukset
GitBook antaa sinun räätälöidä e-kirjasi joustavilla kokoonpanoilla.
Nämä vaihtoehdot on määritelty book.json-tiedostossa. Kirjoittajille, jotka eivät tunne JSON-syntaksia, voit tarkistaa syntaksin työkaluilla kuten JSONlint.
muuttuja | kuvaus | | juuri | Polku juurikansioon, joka sisältää kaikki kirjatiedostot paitsi book.json | | Rakenne | Määritä readme-polut, tiivistelmät, sanastot jne | | Nimi | Kirjasi nimi, oletusarvo poimitaan README-tiedostosta. GitBook.com tämä kenttä on valmiiksi täytetty. | | descrip{filter}tion | Kirjasi kuvaus, oletusarvo, poimitaan README-tiedostosta. GitBook.com tämä kenttä on valmiiksi täytetty. | | Kirjailija | Kirjoittajan nimi. GitBook.com tämä kenttä on valmiiksi täytetty. | | ISBN | ISBN | | Kieli | Tämän kirjan kielityyppi on ISO-koodi. Oletusarvo on en | | Ohjaus | Tekstin lukujärjestys. Se voi olla RTL (oikealta vasemmalle) tai LTR (vasemmalta oikealle), ja oletusarvo riippuu kielen arvosta. | | gitbook | GitBook-versiota tulisi käyttää. Käytä SemVer-määrittelyä ja hyväksy ehdot, jotka ovat samankaltaisia kuin "> = 3.0.0". |
|
Julkaistu 23.11.2018 14.03.54
|
|
|
|
