"GitBook" yra Node.js pagrindu sukurtas komandų eilutės įrankis, palaikantis "Markdown" ir "AsciiDoc" sintaksės formatus ir galintis išvesti el. knygas HTML, PDF, el. knygomis ir kitais formatais.
Įdiekite node.js
Prieš naudodami "gitbook" įrankį, kompiuteris turi įdiegti node.js aplinką, o įdiegę galite patikrinti versijos komandą, kad patikrintumėte, ar diegimas sėkmingas:
Įdiekite "Gitbook"
"Gitbook" įdiegta su npm, komandine eilute:
Paleiskite toliau pateiktą komandą, kad pamatytumėte "GitBook" versiją ir patikrintumėte, ar diegimas buvo sėkmingas.
Istorinių versijų diegimas
"gitbook-cli" leidžia lengvai atsisiųsti ir įdiegti kitas "GitBook" versijas, kad galėtumėte išbandyti knygas:
Naudojant "gitbook ls-remote" išvardijamos versijos, kurias galima atsisiųsti.
"Markdown" redaktorius
Čia mes naudojame "Markdown" sintaksę kaip savo dokumentų rašymo kalbą, turime paruošti "Markdown" redaktorių, rinkoje galime rasti daug "Markdown" redaktorių, tokių kaip "Typora", "MacDown", "Bear", "MarkdownPad", "MarkdownX", "JetBrains" IDE (reikia įdiegti papildinį), "Atom", "Jianshu", CSDN ir "GitBook" "GitBook" redaktorius ir pan.
Mano kompiuteryje įdiegti VS kodo kūrimo įrankiai, vs kodas pagal numatytuosius nustatymus palaiko žymėjimą, man tereikia įdiegti peržiūros papildinio artefaktą: Markdown Preview Enhanced, ir aš jį naudosiu!
Rekomendavo draugai Redaktorius typora, adresas:Hipersaito prisijungimas matomas.
Inicijuoti knygą
"GitBook" gali nustatyti katilą:
Jei norite sukurti knygą naujame kataloge, galite tai padaryti paleisdami gitbook init ./directory.
Po vykdymo pamatysite dar du failus - README.md ir SUMMARY.md, kurie atlieka šiuos veiksmus:
README.md - Knygos įvadas parašytas šiame dokumente
SUMMARY.md – čia sukonfigūruota knygos katalogo struktūra
Aš nesu susipažinęs su markdown sintaksė, todėl tiesiog parašyti keletą sakinių!
Sukurkite statinius tinklalapius
Sukurkite statinius tinklalapius ir paleiskite serverius
Visa tai bus sugeneruota knygų kataloge _book.
Komanda serve taip pat gali nurodyti prievadą:
Generuodami nurodykite "gitbook" versiją ir ji nebus atsisiųsta vietoje
Išvardijamos visos vietinės "gitbook" versijos
Išvardinkite nuotoliniu būdu pasiekiamas "Gitbook" versijas
Įdiekite atitinkamą "Gitbook" versiją
Atnaujinkite į naujausią "gitbook" versiją
Pašalinkite atitinkamą "gitbook" versiją
Nurodo žurnalo lygį
Išvesties klaidos pranešimas
Santrauka
"GitBook" naudoja SUMMARY.md failus, kad apibrėžtų knygos skyrių ir poskyrių struktūrą. SUMMARY.md failas naudojamas knygos turiniui generuoti.
SUMMARY.md formatas yra nuorodų sąrašas. Nuorodos pavadinimas bus skyriaus pavadinimas, o nuoroda bus nukreipta į kelią į to skyriaus failą.
Įtraukus įdėtąjį sąrašą į pirminį skyrių, sukuriamas antrinis skyrius.
Paprastas pavyzdys:
Tada grįžtame į komandinę eilutę ir vėl paleidžiame komandą "gitbook init" aplanke "mybook". "GitBook" ieško katalogų ir failų, aprašytų SUMMARY.md failuose,Jei ne, jis sukuriamas。
Išvestis PDF, ePub arba mobi failus
Jei norite sugeneruoti pdf versiją, galite paleisti gitbook pdf, taip pat, jei eksportuojate epub formatą, gitbook epub, jei tai yra mobi formatas, tai padarys gitbook mobi.
Jei norite eksportuoti el. knygą PDF, ePub arba mobi formatu,Reikalingas "Calibre" el. knygų skaitytuvas / tvarkytuvas ir komandinės eilutės įrankiai, priešingu atveju gali būti pranešta apie klaidą "EbookError: Klaida generuojant el. knygą: 'ebook-convert'".
"GitBook" specialiųjų failų savybės:
failas | apibūdinimas | | book.json | Konfigūracijos duomenys (pasirinktinai) | | README.md | Įžanga arba įvadas į el. knygą (būtina) | | SUMMARY.md | El. knygų katalogas (pasirinktinai) | | GLOSSARY.md | Žodyno ir (arba) anotacijų terminų sąrašas (neprivaloma) |
"Gitbook" bendrieji nustatymai
"GitBook" leidžia tinkinti el. knygą lanksčiomis konfigūracijomis.
Šios parinktys nurodytos book.json faile. Autoriai, kurie nėra susipažinę su JSON sintakse, gali patikrinti sintaksę naudodami tokius įrankius kaip JSONlint.
kintamasis | apibūdinimas | | šaknis | Šakninio aplanko, kuriame yra visi knygos failai, išskyrus book.json | | Struktūra | Nurodykite readme, santraukų, žodynėlių ir kt. kelius | | Pavadinimas | Jūsų knygos pavadinimas, numatytoji vertė išgaunama iš README. GitBook.com šis laukas yra iš anksto užpildytas. | | descrip{filter}tion | Jūsų knygos aprašymas, numatytoji vertė yra išgaunama iš README. GitBook.com šis laukas yra iš anksto užpildytas. | | Autorius | Autoriaus vardas. GitBook.com šis laukas yra iš anksto užpildytas. | | ISBN | ISBN | | Kalba | Šios knygos kalbos tipas yra ISO kodas. Numatytoji reikšmė yra en | | Kryptis | Teksto skaitymo tvarka. Tai gali būti RTL (iš dešinės į kairę) arba LTR (iš kairės į dešinę), o numatytoji reikšmė priklauso nuo kalbos reikšmės. | | gitbook | Turėtų būti naudojama "GitBook" versija. Naudokite SemVer specifikaciją ir sutikite su sąlygomis, panašiomis į "> = 3.0.0". |
|
Paskelbta 2018-11-23 14:03:54
|
|
|
|
