GitBook je príkazový nástroj založený na Node.js, ktorý podporuje formáty syntaxe Markdown a AsciiDoc a dokáže generovať eKnihy v HTML, PDF, eBookoch a ďalších formátoch.
Inštalujte node.js
Pred použitím nástroja gitbook musí počítač nainštalovať node.js prostredie a po inštalácii môžete skontrolovať príkaz version, aby ste otestovali, či je inštalácia úspešná:
Nainštalovať Gitbook
Gitbook je nainštalovaný s npm, príkazový riadok:
Spusti príkaz nižšie, aby si videl verziu GitBooku a overil si, že inštalácia bola úspešná.
Inštalácia historických verzií
gitbook-cli uľahčuje sťahovanie a inštaláciu ďalších verzií GitBooku na testovanie vašich kníh:
Použitie gitbook ls-remote vymenúva verzie, ktoré je možné stiahnuť.
Markdown editor
Tu používame Markdown syntax ako písací jazyk pre naše dokumenty, potrebujeme pripraviť editor Markdownu, na trhu nájdeme mnoho Markdown editorov, ako napríklad Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE od JetBrains (vyžaduje inštaláciu pluginu), Atom, Jianshu, CSDN a vlastný editor od GitBooku GitBook Editor a podobne.
Na počítači mám nainštalované nástroje na vývoj VS kódu, VS Code štandardne podporuje markdown, stačí nainštalovať artefakt náhľadového pluginu: Markdown Preview Enhanced, a budem ho používať!
Odporúčané priateľmi Editor typora, adresa:Prihlásenie na hypertextový odkaz je viditeľné.
Inicializujte knihu
GitBook dokáže nastaviť boilerplate:
Ak chcete vytvoriť knihu do nového adresára, môžete to urobiť spustením gitbook init ./directory.
Po vykonaní uvidíte ďalšie dva súbory – README.md a SUMMARY.md, ktoré robia nasledovné:
README.md - Úvod knihy je uvedený v tomto dokumente
SUMMARY.md - Katalógová štruktúra knihy je tu nastavená
Nie som oboznámený so syntaxou markdown, tak napíšte len pár viet!
Generujte statické webové stránky
Generujte statické webové stránky a spúšťajte servery
Všetko vyššie uvedené bude vygenerované v knižnom katalógu _book.
Príkaz serve môže tiež špecifikovať port:
Pri generovaní zadajte verziu gitbooku, ktorý sa najskôr lokálne nesťahuje
Uvádza všetky lokálne verzie gitbooku
Uveďte verzie gitbooku, ktoré sú dostupné na diaľku
Nainštalujte zodpovedajúcu verziu gitbooku
Aktualizácia na najnovšiu verziu gitbooku
Odinštalujte príslušnú verziu gitbooku
Špecifikuje úroveň logaritmu
Výstupná chybová správa
Zhrnutie
GitBook používa SUMMARY.md súbory na definovanie štruktúry kapitol a podkapitol knihy. SUMMARY.md súbor sa používa na generovanie obsahu knihy.
Formát SUMMARY.md je zoznam odkazov. Názov odkazu bude slúžiť ako názov kapitoly a odkaz bude zameraný na cestu k súboru danej kapitoly.
Pridaním vnoreného zoznamu do nadradenej kapitoly vznikne podkapitola.
Jednoduchý príklad:
Potom sa vrátime do príkazového riadku a znova spustíme príkaz gitbook init v priečinku mybook. GitBook hľadá adresáre a súbory opísané v SUMMARY.md súboroch,Ak nie, je vytvorený。
Výstup PDF, ePub alebo mobi súborov
Ak chcete vygenerovať pdf verziu, môžete spustiť gitbook pdf, rovnako ako ak exportujete epub formát, gitbook epub, ak je to mobi formát, gitbook mobi postačí.
Ak chcete exportovať e-knihu vo formáte PDF, ePub alebo mobi,Vyžaduje Calibre eBook Reader/Manager a nástroje na príkazový riadok, inak môže byť nahlásená chyba "EbookError: Error during ebook generation: 'ebook-convert'".
Vlastnosti GitBook Special Files:
súbor | popis | | book.json | Konfiguračné dáta (voliteľné) | | README.md | Predslov alebo úvod k eBooku (povinné) | | SUMMARY.md | Katalóg e-kníh (voliteľné) | | GLOSSARY.md | Zoznam slovnej zásoby/anotácií (voliteľné) |
Gitbook Všeobecné nastavenia
GitBook vám umožňuje prispôsobiť si e-knihu flexibilnými konfiguráciami.
Tieto možnosti sú špecifikované v book.json súbore. Pre autorov, ktorí nie sú oboznámení so syntaxou JSON, si môžete syntax overiť pomocou nástrojov ako JSONlint.
Premenná | popis | | koreň | Cesta k koreňovému priečinku, ktorý obsahuje všetky knižné súbory okrem book.json | | Štruktúra | Špecifikujte cesty pre readme, abstrakty, glosáre a podobne | | Názov | Názov vašej knihy, predvolená hodnota, sa extrahuje z README. Na GitBook.com je toto pole predobsadené. | | descrip{filter}tion | Popis vašej knihy, predvolená hodnota, sa vyberá z README. Na GitBook.com je toto pole predobsadené. | | autor | Meno autora. Na GitBook.com je toto pole predobsadené. | | ISBN | ISBN | | Jazyk | Jazykový typ tejto knihy je ISO kód. Predvolená hodnota je en | | Smerovanie | Poradie čítania textu. Môže to byť RTL (sprava doľava) alebo LTR (zľava doprava) a predvolená hodnota závisí od hodnoty jazyka. | | gitbook | Mal by sa použiť GitBook verzia. Použite špecifikáciu SemVer a prijmite podmienky podobné "> = 3.0.0". |
|
Zverejnené 23. 11. 2018 14:03:54
|
|
|
|
