GitBook je příkazový nástroj založený na Node.js, který podporuje syntaxi Markdown a AsciiDoc a dokáže generovat e-knihy v HTML, PDF, eBooku a dalších formátech.
Nainstalovat node.js
Před použitím nástroje gitbook musí počítač nainstalovat node.js prostředí a po instalaci můžete zkontrolovat příkaz version, abyste otestovali, zda je instalace úspěšná:
Instalace Gitbooku
Gitbook je nainstalován s npm, příkazový řádek:
Spusťte níže uvedený příkaz a podívejte se na verzi GitBooku a ověřte si úspěšnou instalaci.
Instalace historických verzí
gitbook-cli usnadňuje stažení a instalaci dalších verzí GitBooku pro testování vašich knih:
Použití gitbook ls-remote vyjmenovává verze, které lze stáhnout.
Editor Markdown
Zde používáme syntaxi Markdownu jako jazyk pro psaní našich dokumentů, potřebujeme připravit editor Markdownu, na trhu najdeme mnoho editorů Markdownu, jako jsou Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE od JetBrains (vyžaduje instalaci pluginu), Atom, Jianshu, CSDN a vlastní editor od GitBooku GitBook Editor a podobně.
Na počítači mám nainstalované nástroje pro vývoj VS kódu, VS Code standardně podporuje markdown, stačí nainstalovat artefakt náhledového pluginu: Markdown Preview Enhanced, a budu ho používat i já!
Doporučeno přáteli Editor typora, adresa:Přihlášení k hypertextovému odkazu je viditelné.
Inicializace knihy
GitBook může nastavit boilerplate:
Pokud chcete vytvořit knihu do nového adresáře, můžete to udělat spuštěním gitbook init ./directory.
Po spuštění uvidíte další dva soubory – README.md a SUMMARY.md, které dělají následující:
README.md - Úvod knihy je uveden v tomto dokumentu
SUMMARY.md - Zde je konfigurována katalogová struktura knihy
Nejsem obeznámený se syntaxí markdown, tak si prostě napiš pár vět!
Generování statických webových stránek
Generujte statické webové stránky a provozujte servery
Vše výše uvedené bude zpracováno v katalogu knih _book.
Příkaz serve může také specifikovat port:
Při generování specifikujte verzi gitbooku, který se nejdříve nestáhne lokálně
Seznam všech lokálních verzí gitbooku
Uveďte verze gitbooku, které jsou dostupné na dálku
Nainstalujte odpovídající verzi gitbooku
Aktualizace na nejnovější verzi gitbooku
Odinstalujte odpovídající verzi gitbooku
Specifikuje úroveň logaritmu
Výstupní chybová zpráva
Shrnutí
GitBook používá SUMMARY.md soubory k definování struktury kapitol a podkapitol knihy. SUMMARY.md soubor se používá k vytvoření obsahu knihy.
Formát SUMMARY.md je seznam odkazů. Název odkazu bude sloužit jako název kapitoly a odkaz bude zaměřen na cestu k souboru dané kapitoly.
Přidání vnořeného seznamu do mateřské kapitoly vytvoří podkapitolu.
Jednoduchý příklad:
Pak se vrátíme do příkazové řádky a spustíme příkaz init gitbook znovu ve složce mybook. GitBook hledá adresáře a soubory popsané v SUMMARY.md souborech,Pokud ne, je vytvořen。
Výstup PDF, ePub nebo mobi souborů
Pokud chcete vytvořit pdf verzi, můžete spustit gitbook pdf, stejně jako pokud exportujete formát epub, gitbook epub, pokud je to mobi formát, gitbook mobi postačí.
Pokud chcete exportovat e-knihu ve formátu PDF, ePub nebo mobi,Vyžaduje Calibre Reader/Manager eBook a nástroje pro příkazovou řádku, jinak může být nahlášena chyba "EbookError: Error during ebook generation: 'ebook-convert'".
Vlastnosti GitBook Special Files:
soubor | popis | | book.json | Konfigurační data (volitelné) | | README.md | Předmluva nebo úvod k eBooku (povinné) | | SUMMARY.md | Katalog elektronických knih (volitelné) | | GLOSSARY.md | Seznam slovních/anotačních termínů (volitelné) |
Obecná nastavení Gitbooku
GitBook vám umožňuje přizpůsobit si ebook pomocí flexibilních konfigurací.
Tyto možnosti jsou specifikovány v souboru book.json. Pro autory, kteří nejsou obeznámeni se syntaxí JSON, můžete syntaxi ověřit pomocí nástrojů jako JSONlint.
proměnná | popis | | kořen | Cesta ke kořenové složce, která obsahuje všechny soubory knih, kromě book.json | | Struktura | Určte cesty pro readme, abstrakty, glosáře atd | | Název | Název vaší knihy, výchozí hodnota, se extrahuje z README. Na GitBook.com je toto pole předem vyplněné. | | descrip{filter}tion | Popis vaší knihy, výchozí hodnota, se extrahuje z README. Na GitBook.com je toto pole předem vyplněné. | | autor | Jméno autora. Na GitBook.com je toto pole předem vyplněné. | | ISBN | ISBN | | Jazyk | Jazykovým typem této knihy je ISO kód. Výchozí hodnota je en | | Režie | Pořadí čtení textu. Může to být RTL (zprava doleva) nebo LTR (zleva doprava) a výchozí hodnota závisí na hodnotě jazyka. | | gitbook | Měla by se použít verze pro GitBook. Použijte specifikaci SemVer a přijímejte podmínky podobné "> = 3.0.0". |
|
Zveřejněno 23.11.2018 14:03:54
|
|
|
|
