GitBook on Node.js-põhine käsurea tööriist, mis toetab Markdowni ja AsciiDoc süntaksi formaate ning suudab väljundida e-raamatuid HTML-is, PDF-is, e-raamatus ja muudes formaatides.
Paigalda node.js
Enne gitbooki tööriista kasutamist peab arvuti paigaldama node.js keskkonna ning pärast paigaldamist saad kontrollida versioonikäsku, et kontrollida, kas paigaldus õnnestub:
Installi Gitbook
Gitbook on paigaldatud npm-iga, käsureada:
Käivita allolev käsk, et näha GitBooki versiooni ja veenduda, et paigaldus õnnestus.
Paigalda ajaloolised versioonid
gitbook-cli teeb lihtsaks teiste GitBooki versioonide allalaadimise ja installimise, et oma raamatuid testida:
Gitbooki kasutamine ls-remote loetleb allalaaditavad versioonid.
Markdowni redaktor
Siin kasutame Markdowni süntaksit oma dokumentide kirjutamiskeelena, peame ette valmistama Markdowni redaktori, turul leidub palju Markdowni redaktoreid, nagu Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrainsi IDE (vajab plugina paigaldamist), Atom, Jianshu, CSDN ja GitBooki enda oma GitBook Editor ja nii edasi.
Mul on arvutis VS koodi arendustööriistad paigaldatud, VS Code toetab vaikimisi markdowni, mul on vaja ainult paigaldada eelvaate plugina artefakt: Markdown Preview Enhanced, ja kasutan seda!
Soovitatud sõprade poolt. Toimetaja typora, aadress:Hüperlingi sisselogimine on nähtav.
Initsialiseeri raamat
GitBook saab seadistada boilerplate'i:
Kui soovid luua raamatu uude kataloogi, saad seda teha, käivitades gitbook init ./directory.
Pärast täitmist näed veel kahte faili – README.md ja SUMMARY.md, mis teevad järgmist:
README.md - Raamatu sissejuhatus on kirjas selles dokumendis
SUMMARY.md - Raamatu kataloogistruktuur on siin seadistatud
Ma ei tunne markdowni süntaksit, nii et kirjuta lihtsalt paar lauset!
Loo staatilised veebilehed
Loo staatilised veebilehed ja käivita servereid
Kõik eelnev genereeritakse raamatukataloogis _book.
Serveerimiskäsk võib määrata ka porti:
Genereerimisel määra gitbooki versioon ja seda ei laadita esmalt lokaalselt alla
Loetleb kõik kohalikud gitbooki versioonid
Loetle gitbooki versioonid, mis on kaugelt saadaval
Paigalda vastav gitbooki versioon
Uuendus Gitbooki viimasele versioonile
Desinstalli vastav gitbooki versioon
Määrab logi taseme
Väljundveateade
Kokkuvõte
GitBook kasutab SUMMARY.md faile, et määratleda raamatu peatükkide ja alapeatükkide struktuur. SUMMARY.md faili kasutatakse raamatu sisukorra genereerimiseks.
SUMMARY.md formaat on linkide nimekiri. Lingi pealkiri toimib peatüki pealkirjana ning link suunatakse selle peatüki faili teele.
Lisades pesastatud nimekirja vanempeatükile, tekib lapspeatükk.
Lihtne näide:
Seejärel läheme tagasi käsureale ja käivitame mybook kaustas uuesti gitbook init käsu. GitBook otsib katalooge ja faile, mis on kirjeldatud SUMMARY.md failides,Kui mitte, siis see luuakse。
Väljasta PDF-, ePub- või mobi-failid
Kui tahad genereerida pdf-versiooni, võid käivitada gitbook pdf-i, samamoodi kui ekspordid epub-formaadi, gitbook epub, kui mobi formaat, siis gitbook mobi sobib.
Kui soovid eksportida e-raamatu PDF-, ePub- või mobi-formaadis,Vajab Calibre eBook Readerit/Managerit ja käsurea tööriistu, vastasel juhul võidakse teatada vea "EbookError: Error from ebook generation: 'ebook-convert'".
GitBook erifailide omadused:
fail | kirjeldus | | book.json | Konfiguratsiooniandmed (valikuline) | | README.md | E-raamatu eessõna või sissejuhatus (kohustuslik) | | SUMMARY.md | E-raamatute kataloog (valikuline) | | GLOSSARY.md | Sõnavara/annotatsiooniterminite nimekiri (valikuline) |
Gitbooki üldised seaded
GitBook võimaldab kohandada oma e-raamatut paindlike seadistustega.
Need valikud on määratletud book.json failis. Autoritele, kes JSON-süntaksiga tuttavad ei ole, saab süntaksit kontrollida tööriistadega nagu JSONlint.
muutuja | kirjeldus | | juur | Tee juurkausta, mis sisaldab kõiki raamatufaile, välja arvatud book.json | | Struktuur | Määra readme, abstraktide, sõnastiku jms jaoks rajad | | Pealkiri | Sinu raamatu pealkiri, vaikimisi väärtus võetakse README-st. GitBook.com on see väli eelnevalt asustatud. | | descrip{filter}tion | Sinu raamatu kirjeldus, vaikimisi väärtus, võetakse README-st. GitBook.com on see väli eelnevalt asustatud. | | Autor | Autori nimi. GitBook.com on see väli eelnevalt asustatud. | | ISBN | ISBN | | Keel | Selle raamatu keeletüüp on ISO kood. Vaikimisi väärtus on en | | Režii | Teksti lugemise järjekord. See võib olla RTL (paremalt vasakule) või LTR (vasakult paremale) ning vaikimisi väärtus sõltub keele väärtusest. | | gitbook | Tuleks kasutada GitBooki versiooni. Kasuta SemVer spetsifikatsiooni ja aktsepteeri tingimusi, mis on sarnased "> = 3.0.0". |
|
Postitatud 23.11.2018 14:03:54
|
|
|
|
