A GitBook egy Node.js-alapú parancssor-eszköz, amely támogatja a Markdown és AsciiDoc szintaxisformátumokat, és képes e-könyveket HTML, PDF, eBook és más formátumokban is kiadni.
Telepítsd node.js
A gitbook eszköz használata előtt a számítógépnek telepítenie kell node.js környezetet, és telepítés után ellenőrizheted a verzióparancsot, hogy teszteld, sikeres volt-e a telepítés:
Telepítsd a Gitbookot
A Gitbook npm-mel van telepítve, parancssor:
Futtatd le az alábbi parancsot, hogy megnézd a GitBook verziót, és ellenőrizd, sikeres volt-e a telepítés.
Történelmi verziók telepítése
A gitbook-cli megkönnyíti a GitBook más verzióinak letöltését és telepítését, hogy teszteld a könyveidet:
A gitbook használatával ls-remote felsorolja a letölthető verziókat.
Markdown szerkesztő
Itt a Markdown szintaxisát használjuk írásnyelvként a dokumentumainkhoz, elő kell készítenünk egy Markdown szerkesztőt, sok Markdown szerkesztőt találunk a piacon, például Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrains IDE-je (plugin telepítést igényel), Atom, Jianshu, CSDN és a GitBook saját szerkesztője GitBook szerkesztő és így tovább.
Van telepítve a VS kódfejlesztő eszközök a számítógépemen, a VS Code alapértelmezettben támogatja a markdown-t, csak egy előnézeti plugin artefaktumot kell telepítenem: Markdown Preview Enhanced, és használni fogom!
Barátaim ajánlása Szerkesztő typora, cím:A hiperlink bejelentkezés látható.
Inicializálni egy könyvet
A GitBook képes egy sablont beállítani:
Ha egy könyvet szeretnél létrehozni egy új könyvtárba, ezt úgy teheted meg, hogy futtatod a gitbook init ./directory-t.
A végrehajtás után további két fájlt látsz – README.md és SUMMARY.md, amelyek a következőket csinálják:
README.md - A könyv bevezetője ebben a dokumentumban van írva.
SUMMARY.md - A könyv katalógusstruktúrája itt van konfigurálva.
Nem vagyok jártas a markdown szintaxisával, szóval csak írj néhány mondatot!
Statikus weboldalak generálása
Statikus weboldalak generálása és szerverek futtatása
Mindezek a könyvkatalógusban generálódnak _book.
A szerv parancs a portot is megadhatja:
Generáláskor megadd a gitbook verziót, és az nem fog először helyben letölteni
Minden helyi gitbook verziót listáz
Sorold fel a gitbook távolról elérhető verzióit
Telepítsd a megfelelő gitbook verziót
Frissítés a Gitbook legújabb verziójához
Töröld a megfelelő gitbook verziót
Megadja a napló szintjét
Kimeneti hibaüzenet
Összefoglaló
A GitBook SUMMARY.md fájlokat használ a könyv fejezeteinek és alfejezeteinek szerkezetének meghatározására. SUMMARY.md fájlt használnak a könyv tartalomjegyzékének generálásához.
A SUMMARY.md formátuma egy linkek listája. A link címe a fejezet címeként szolgál, és a link a fejezetfájlhoz vezető útra irányul.
Ha egy peréselő listát adunk a szülő fejezethez, egy gyermekfejezetet hozunk létre.
Egyszerű példa:
Ezután visszamegyünk a parancssorhoz, és újra futtatjuk a gitbook init parancsot a mybook mappában. A GitBook keresi a könyvtárakat és fájlokat, amelyeket SUMMARY.md fájlokban írtak le,Ha nem, akkor létrejön。
PDF, ePub vagy mobi fájlok kimenete
Ha pdf verziót szeretnél generálni, futtathatod a gitbook pdf-et, ugyanúgy, mint ha epub formátumot exportálsz, gitbook epub, ha mobi formátumú, akkor a gitbook mobi megteszi.
Ha szeretnél e-könyvet exportálni PDF, ePub vagy mobi formátumban,Calibre eBook Reader/Manager és parancssoros eszközök szükségesek, különben hibát jelenthetünk: "EbookError: Error during ebook generation: 'ebook-convert'".
A GitBook Special Files jellemzői:
fájl | leírás | | book.json | Konfigurációs adatok (opcionális) | | README.md | Előszó vagy bevezetés az e-könyvhöz (kötelező) | | SUMMARY.md | E-könyv katalógus (opcionális) | | GLOSSARY.md | Szókincs/annotációs kifejezések listája (opcionális) |
Gitbook általános beállítások
A GitBook lehetővé teszi, hogy rugalmas konfigurációkkal testreszabd az e-könyvedet.
Ezek az opciók a book.json fájlban vannak megadva. Azok számára, akik nem ismerik a JSON szintaxist, ellenőrizheted a szintaxist olyan eszközökkel, mint a JSONlint.
változó | leírás | | gyökér | Az út a gyökérmappához, amely tartalmazza az összes könyvfájlt, kivéve book.json | | Szerkezet | Jelöld meg az útvonalakat readme-hez, absztraktokhoz, szószótárokhoz stb | | Cím | A könyv címe, az alapértelmezett érték a README-ből van kinyerve. GitBook.com-n ez a mező előre benépesített. | | descrip{filter}tion | A könyved leírása, az alapértelmezett érték a README-ből van kinyerve. GitBook.com-n ez a mező előre benépesített. | | szerző | A szerző neve. GitBook.com-n ez a mező előre benépesített. | | ISBN | ISBN | | Nyelv | A könyv nyelvtípusa ISO kód. Az alapértelmezett érték en: | | Rendező | Szövegolvasási sorrend. Lehet RTL (jobbról balra) vagy LTR (balról jobbra), és az alapértelmezett érték a nyelv értékétől függ. | | gitbook | A GitBook verziót kell használni. Használd a SemVer specifikációt, és fogadj el olyan feltételeket, amelyek hasonlóak a "> = 3.0.0"-hoz. |
|
Közzétéve 2018. 11. 23. 14:03:54
|
|
|
|
