GitBook este un instrument de linie de comandă bazat pe Node.js care suportă formatele de sintaxă Markdown și AsciiDoc și poate genera eBook-uri în HTML, PDF, eBook și alte formate.
Instalează node.js
Înainte de a folosi instrumentul gitbook, calculatorul trebuie să instaleze mediul node.js, iar după instalare, poți verifica comanda version pentru a verifica dacă instalarea are succes:
Instalează Gitbook
Gitbook este instalat cu npm, linie de comandă:
Rulează comanda de mai jos pentru a vedea versiunea GitBook și a verifica dacă instalarea a fost reușită.
Instalează versiunile istorice
gitbook-cli face ușoară descărcarea și instalarea altor versiuni de GitBook pentru a-ți testa cărțile:
Folosirea gitbook ls-remote enumeră versiunile care pot fi descărcate.
Editor Markdown
Aici folosim sintaxa Markdown ca limbaj de scriere pentru documentele noastre, trebuie să pregătim un editor Markdown, putem găsi mulți editori Markdown pe piață, precum Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE-ul JetBrains (necesită instalarea unui plugin), Atom, Jianshu, CSDN și cel propriu al GitBook GitBook Editor și așa mai departe.
Am instalate unelte de dezvoltare VS Code pe calculator, VS Code suportă markdown implicit, trebuie doar să instalez un artefact plugin de previzualizare: Markdown Preview Enhanced, și îl voi folosi!
Recomandat de prieteni Editor de tipar, adresă:Autentificarea cu hyperlink este vizibilă.
Inițializează o carte
GitBook poate configura un boilerplate:
Dacă dorești să creezi o carte într-un nou director, poți face acest lucru rulând gitbook init ./directory.
După execuție, veți vedea încă două fișiere - README.md și SUMMARY.md, care fac următoarele:
README.md - Introducerea cărții este scrisă în acest document SUMMARY.md - Structura catalogului cărții este configurată aici
Nu sunt familiarizat cu sintaxa markdown, așa că scrie doar câteva propoziții!
Generează pagini web statice
Generează pagini web statice și rulează servere
Toate cele de mai sus vor fi generate în catalogul de cărți _book.
Comanda de servire poate specifica, de asemenea, portul:
Când generezi, specifică versiunea de gitbook și nu va fi descărcat local mai întâi
Listează toate versiunile locale de gitbook
Listează versiunile de gitbook disponibile de la distanță
Instalează versiunea corespunzătoare de gitbook
Actualizare la cea mai recentă versiune de gitbook
Desinstalează versiunea corespunzătoare de gitbook
Specifică nivelul logaritmic
Mesaj de eroare de ieșire
Rezumat
GitBook folosește fișiere SUMMARY.md pentru a defini structura capitolelor și subcapitolelor cărții. SUMMARY.md fișier este folosit pentru generarea cuprinsului cărții.
Formatul SUMMARY.md este o listă de linkuri. Titlul linkului va servi drept titlu capitolului, iar linkul va fi direcționat către traseul către acel fișier capitol.
Adăugarea unei liste imbricate în capitolul părinte creează un capitol copil.
Exemplu simplu:
Apoi ne întoarcem la linia de comandă și rulăm din nou comanda init din gitbook în folderul mybook. GitBook caută directoare și fișiere descrise în SUMMARY.md fișiere,Dacă nu, este creat。
Fișiere PDF, ePub sau mobi
Dacă vrei să generezi o versiune pdf, poți rula gitbook pdf, în același mod, dacă exporti format epub, gitbook epub, dacă este format mobi, gitbook mobi este suficient.
Dacă vrei să exporti o carte electronică în format PDF, ePub sau mobi,Necesită Calibre eBook Reader/Manager și instrumente de linie de comandă, altfel poate fi raportată o eroare "EbookError: Eroare în timpul generării ebook-ului: 'ebook-convert'".
Caracteristici ale fișierelor speciale GitBook:
dosar | descriere | | book.json | Date de configurare (opțional) | | README.md | Prefață sau introducere la eBook (obligatoriu) | | SUMMARY.md | Catalog de cărți electronice (opțional) | | GLOSSARY.md | Listă de termeni de vocabular/adnotare (opțional) | Setări generale pentru Gitbook
GitBook îți permite să-ți personalizezi ebook-ul cu configurații flexibile.
Aceste opțiuni sunt specificate în fișierul book.json. Pentru autorii care nu sunt familiarizați cu sintaxa JSON, poți verifica sintaxa folosind instrumente precum JSONlint.
variabilă | descriere | | rădăcină | Calea către folderul rădăcină care conține toate fișierele cărții, cu excepția book.json | | Structură | Specifică căi pentru readme, rezumate, glosare etc | | Titlu | Titlul cărții tale, valoarea implicită este extrasă din README. Pe GitBook.com, acest câmp este prepopulat. | | descrip{filter}tion | Descrierea cărții tale, valoarea implicită, este extrasă din README. Pe GitBook.com, acest câmp este prepopulat. | | Autor | Numele autorului. Pe GitBook.com, acest câmp este prepopulat. | | ISBN | ISBN | | Limbă | Tipul de limbaj al acestei cărți este codul ISO. Valoarea implicită este en | | Regie | Ordinea citirii textului. Poate fi RTL (de la dreapta la stânga) sau LTR (de la stânga la dreapta), iar valoarea implicită depinde de valoarea limbajului. | | gitbook | Ar trebui folosită versiunea GitBook. Folosește specificația SemVer și acceptă condiții similare cu "> = 3.0.0". |
|