GitBook ir uz Node.js balstīts komandrindas rīks, kas atbalsta Markdown un AsciiDoc sintakses formātus un var izvadīt e-grāmatas HTML, PDF, e-grāmatā un citos formātos.
Instalējiet node.js
Pirms gitbook rīka izmantošanas datoram ir jāinstalē node.js vidē, un pēc instalēšanas varat pārbaudīt versijas komandu, lai pārbaudītu, vai instalēšana ir veiksmīga:
Instalējiet Gitbook
Gitbook ir instalēts ar npm, komandrindu:
Palaidiet tālāk norādīto komandu, lai redzētu GitBook versiju un pārbaudītu, vai instalēšana ir bijusi veiksmīga.
Vēsturisko versiju instalēšana
gitbook-cli atvieglo citu GitBook versiju lejupielādi un instalēšanu, lai pārbaudītu grāmatas:
Izmantojot gitbook ls-remote, tiek uzskaitītas versijas, kuras var lejupielādēt.
Markdown redaktors
Šeit mēs izmantojam Markdown sintaksi kā mūsu dokumentu rakstīšanas valodu, mums ir jāsagatavo Markdown redaktors, tirgū varam atrast daudzus Markdown redaktorus, piemēram, Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrains IDE (nepieciešama spraudņa instalēšana), Atom, Jianshu, CSDN un GitBook GitBook redaktors un tā tālāk.
Manā datorā ir instalēti VS koda izstrādes rīki, vs kods pēc noklusējuma atbalsta markdown, man ir jāinstalē tikai priekšskatījuma spraudņa artefakts: Markdown Preview Enhanced, un es to izmantošu!
Iesaka draugi Redaktors typora, adrese:Hipersaites pieteikšanās ir redzama.
Grāmatas inicializēšana
GitBook var iestatīt boilerplate:
Ja vēlaties izveidot grāmatu jaunā direktorijā, varat to izdarīt, palaižot gitbook init ./directory.
Pēc izpildes jūs redzēsiet vēl divus failus - README.md un SUMMARY.md, kas rīkojas šādi:
README.md - Grāmatas ievads ir rakstīts šajā dokumentā
SUMMARY.md - Grāmatas kataloga struktūra ir konfigurēta šeit
Es neesmu pazīstams ar markdown sintaksi, tāpēc vienkārši uzrakstiet dažus teikumus!
Statisku tīmekļa lapu ģenerēšana
Ģenerējiet statiskas tīmekļa lapas un palaidiet serverus
Viss iepriekš minētais tiks ģenerēts grāmatu katalogā _book.
Serve komanda var norādīt arī portu:
Ģenerējot, norādiet gitbook versiju, un tā vispirms netiks lejupielādēta lokāli
Uzskaita visas vietējās gitbook versijas
Uzskaitiet attālināti pieejamās gitbook versijas
Instalējiet atbilstošo gitbook versiju
Atjaunināšana uz jaunāko gitbook versiju
Atinstalējiet atbilstošo gitbook versiju
Norāda žurnāla līmeni
Izvades kļūdas ziņojums
Kopsavilkums
GitBook izmanto SUMMARY.md failus, lai definētu grāmatas nodaļu un apakšnodaļu struktūru. SUMMARY.md fails tiek izmantots, lai ģenerētu grāmatas satura rādītāju.
SUMMARY.md formāts ir saišu saraksts. Saites nosaukums kalpos kā nodaļas nosaukums, un saite būs vērsta uz ceļu uz šo nodaļas failu.
Pievienojot ligzdotu sarakstu vecāknodaļai, tiek izveidota bērnnodaļa.
Vienkāršs piemērs:
Tad mēs atgriežamies komandrindā un vēlreiz palaižam komandu gitbook init mapē mybook. GitBook meklē direktorijus un failus, kas aprakstīti SUMMARY.md failos,Ja nē, tas tiek izveidots。
Izvadiet PDF, ePub vai mobi failus
Ja vēlaties ģenerēt pdf versiju, varat palaist gitbook pdf tādā pašā veidā, ja eksportējat epub formātu, gitbook epub, ja tas ir mobi formāts, darīs gitbook mobi.
Ja vēlaties eksportēt e-grāmatu PDF, ePub vai mobi formātā,Nepieciešams Calibre e-grāmatu lasītājs/pārvaldnieks un komandrindas rīki, pretējā gadījumā var tikt ziņots par kļūdu "EbookError: Kļūda e-grāmatu ģenerēšanas laikā: 'ebook-convert'".
GitBook īpašo failu funkcijas:
fails | apraksts | | book.json | Konfigurācijas dati (neobligāti) | | README.md | E-grāmatas priekšvārds vai ievads (obligāti) | | SUMMARY.md | E-grāmatu katalogs (pēc izvēles) | | GLOSSARY.md | Vārdu krājuma/anotācijas terminu saraksts (pēc izvēles) |
Gitbook vispārīgie iestatījumi
GitBook ļauj pielāgot savu e-grāmatu ar elastīgām konfigurācijām.
Šīs opcijas ir norādītas book.json failā. Autoriem, kuri nav iepazinušies ar JSON sintaksi, varat pārbaudīt sintaksi, izmantojot tādus rīkus kā JSONlint.
mainīgais | apraksts | | sakne | Ceļš uz saknes mapi, kurā ir visi grāmatu faili, izņemot book.json | | Struktūra | Norādiet ceļus readme, kopsavilkumiem, glosārijiem utt | | Nosaukums | Jūsu grāmatas nosaukums, noklusējuma vērtība tiek iegūta no README. Uz GitBook.com šis lauks ir iepriekš aizpildīts. | | descrip{filter}tion | Jūsu grāmatas apraksts, noklusējuma vērtība tiek iegūta no README. Uz GitBook.com šis lauks ir iepriekš aizpildīts. | | Autors | Autora vārds. Uz GitBook.com šis lauks ir iepriekš aizpildīts. | | ISBN | ISBN | | Valoda | Šīs grāmatas valodas veids ir ISO kods. Noklusējuma vērtība ir en | | virziens | Teksta lasīšanas secība. Tas var būt RTL (no labās uz kreiso) vai LTR (no kreisās uz labo), un noklusējuma vērtība ir atkarīga no valodas vērtības. | | gitbook | Jāizmanto GitBook versija. Izmantojiet SemVer specifikāciju un pieņemiet nosacījumus, kas ir līdzīgi "> = 3.0.0". |
|
Publicēts 23.11.2018 14:03:54
|
|
|
|
