GitBook je ukazno orodje, ki temelji na Node.js, podpira sintaktične formate Markdown in AsciiDoc ter lahko izpiše e-knjige v HTML, PDF, e-knjigah in drugih formatih.
Namestite node.js
Pred uporabo orodja gitbook mora računalnik namestiti node.js okolje, po namestitvi pa lahko preverite ukaz version, da preverite, ali je namestitev uspešna:
Namesti Gitbook
Gitbook je nameščen z npm, ukazna vrstica:
Zaženite spodnji ukaz, da si ogledate različico GitBooka in preverite, ali je bila namestitev uspešna.
Namestite zgodovinske različice
gitbook-cli omogoča enostaven prenos in namestitev drugih različic GitBooka za testiranje vaših knjig:
Uporaba gitbook ls-remote našteje različice, ki jih je mogoče prenesti.
Markdown urejevalnik
Tukaj uporabljamo Markdown sintakso kot pisni jezik za naše dokumente, pripraviti moramo urejevalnik Markdown, na trgu lahko najdemo veliko urejevalnikov Markdown, kot so Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE podjetja JetBrains (zahteva namestitev vtičnika), Atom, Jianshu, CSDN in lastni urejevalnik GitBooka GitBook Editor in podobno.
Na računalniku imam nameščena orodja za razvoj VS kode, VS Code privzeto podpira markdown, namestiti moram le artefakt predvajalnega vtičnika: Markdown Preview Enhanced, in ga bom uporabil!
Priporočili prijatelji Urednik typora, naslov:Prijava do hiperpovezave je vidna.
Inicializirajte knjigo
GitBook lahko nastavi osnovno datoteko:
Če želite ustvariti knjigo v novo imenik, lahko to storite tako, da zaženete gitbook init ./directory.
Po zagonu boste videli še dve datoteki – README.md in SUMMARY.md, ki počneta naslednje:
README.md - Uvod v knjigo je zapisan v tem dokumentu SUMMARY.md - Struktura kataloga knjige je konfigurirana tukaj
Nisem seznanjen z markdown sintakso, zato napiši le nekaj stavkov!
Generiranje statičnih spletnih strani
Generiranje statičnih spletnih strani in poganjanje strežnikov
Vse zgoraj navedeno bo objavljeno v knjižnem katalogu _book.
Ukaz serve lahko določi tudi priključek:
Pri generiranju določite različico gitbooka, ki ga ne bo najprej lokalno prenesel
Navaja vse lokalne gitbook različice
Navedite različice gitbooka, ki so na voljo na daljavo
Namestite ustrezno gitbook različico
Posodobitev na najnovejšo različico gitbooka
Odstrani ustrezno različico gitbooka
Določa raven loga
Izhodno sporočilo o napaki
Povzetek
GitBook uporablja SUMMARY.md datoteke za določanje strukture poglavij in podpoglavij knjige. SUMMARY.md datoteka se uporablja za generiranje kazala vsebine knjige.
Oblika SUMMARY.md je seznam povezav. Naslov povezave bo služil kot naslov poglavja, povezava pa bo usmerjena na pot do te datoteke poglavja.
Dodajanje gnezdenega seznama v nadrejeno poglavje ustvari otroško poglavje.
Preprost primer:
Nato se vrnemo v ukazno vrstico in ponovno zaženemo ukaz gitbook init v mapi mybook. GitBook išče mape in datoteke, opisane v SUMMARY.md datotekah,Če ne, je ustvarjen。
Izpiši PDF, ePub ali mobi datoteke
Če želite ustvariti pdf različico, lahko zaženete gitbook pdf, na enak način, če izvažate epub format, gitbook epub, če je mobi format, bo gitbook mobi zadostoval.
Če želite izvoziti e-knjigo v PDF, ePub ali mobi formatu,Zahteva Calibre bralnik/upravitelj e-knjig in orodja ukazne vrstice, sicer je lahko napaka prijavljena "EbookError: Error during ebook generation: 'ebook-convert'".
Značilnosti GitBook Special Files:
datoteka | opis | | book.json | Konfiguracijski podatki (neobvezno) | | README.md | Predgovor ali uvod v e-knjigo (obvezno) | | SUMMARY.md | Katalog e-knjig (neobvezno) | | GLOSSARY.md | Seznam besedišča/označevalnih izrazov (neobvezno) | Splošne nastavitve Gitbooka
GitBook vam omogoča, da prilagodite svojo e-knjigo s prilagodljivimi konfiguracijami.
Te možnosti so določene v book.json datoteki. Za avtorje, ki niso seznanjeni s sintakso JSON, lahko sintakso preverite z orodji, kot je JSONlint.
spremenljivka | opis | | koren | Pot do korenske mape, ki vsebuje vse knjižne datoteke, razen book.json | | Struktura | Določite poti za readme, povzetke, slovarke itd | | Naslov | Naslov vaše knjige, privzeta vrednost, se izvleče iz README. Na GitBook.com je to polje vnaprej naseljeno. | | descrip{filter}tion | Opis vaše knjige, privzeta vrednost, se izvleče iz README. Na GitBook.com je to polje vnaprej naseljeno. | | Avtor | Ime avtorja. Na GitBook.com je to polje vnaprej naseljeno. | | ISBN | ISBN | | Jezik | Jezikovna vrsta te knjige je ISO koda. Privzeta vrednost je en | | Režija | Vrstni red branja besedila. Lahko je RTL (od desne proti levi) ali LTR (od leve proti desni), privzeta vrednost pa je odvisna od vrednosti jezika. | | gitbook | Uporabiti je treba GitBook različico. Uporabite specifikacijo SemVer in sprejmite pogoje, podobne "> = 3.0.0". |
|