GitBook är ett Node.js-baserat kommandoradsverktyg som stödjer Markdown- och AsciiDoc-syntaxformat, och kan exportera e-böcker i HTML, PDF, e-bok och andra format.
Installera node.js
Innan du använder gitbook-verktyget måste datorn installera node.js miljö, och efter installationen kan du kontrollera versionskommandot för att testa om installationen lyckas:
Installera Gitbook
Gitbook installeras med npm, kommandorad:
Kör kommandot nedan för att se GitBook-versionen och verifiera att installationen lyckades.
Installera historiska versioner
GitBook-CLI gör det enkelt att ladda ner och installera andra versioner av GitBook för att testa dina böcker:
Med hjälp av gitbook räknar ls-remote upp versionerna som kan laddas ner.
Markdown-redigerare
Här använder vi Markdown-syntax som skrivspråk för våra dokument, vi behöver förbereda en Markdown-redigerare, vi kan hitta många Markdown-redigerare på marknaden, såsom Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrains IDE (kräver plugin-installation), Atom, Jianshu, CSDN och GitBooks egen GitBook Editor och så vidare.
Jag har VS-kodutvecklingsverktyg installerade på min dator, VS-koden stöder markdown som standard, jag behöver bara installera en förhandsgranskningsplugin-artefakt: Markdown Preview Enhanced, och jag kommer att använda den!
Rekommenderad av vänner Redaktör typora, adress:Inloggningen med hyperlänken är synlig.
Initiera en bok
GitBook kan skapa en boilerplate:
Om du vill skapa en bok i en ny katalog kan du göra det genom att köra gitbook init ./directory.
Efter körning kommer du att se två filer till – README.md och SUMMARY.md, som gör följande:
README.md - Bokens inledning är skriven i detta dokument SUMMARY.md - Bokens katalogstruktur är konfigurerad här
Jag är inte bekant med markdown-syntax, så skriv bara några meningar!
Generera statiska webbsidor
Generera statiska webbsidor och kör servrar
Allt ovanstående kommer att genereras i bokkatalogen _book.
Serveringskommandot kan också specificera porten:
När du genererar, ange versionen av gitbook, och den kommer inte att laddas ner lokalt först
Listar alla lokala gitbook-versioner
Lista de versioner av gitbook som finns tillgängliga på distans
Installera motsvarande gitbook-version
Uppdatering till den senaste versionen av gitbook
Avinstallera motsvarande gitbook-version
Specificerar nivån på logen
Utdata felmeddelande
Sammanfattning
GitBook använder SUMMARY.md filer för att definiera strukturen på bokens kapitel och underkapitel. SUMMARY.md Fil används för att generera bokens innehållsförteckning.
Formatet på SUMMARY.md är en lista med länkar. Länkens titel fungerar som kapitlets titel, och länken riktas mot vägen till den kapitelfilen.
Att lägga till en nästlad lista i föräldrakapitlet skapar ett barnkapitel.
Enkelt exempel:
Sedan går vi tillbaka till kommandoraden och kör gitbook-kommandot init igen i mybook-mappen. GitBook letar efter kataloger och filer som beskrivs i SUMMARY.md filer,Om inte, skapas den。
Exportera PDF-, ePub- eller mobi-filer
Om du vill generera en pdf-version kan du köra gitbook pdf, på samma sätt som om du exporterar epub-format, gitbook epub, om det är mobi-format fungerar gitbook mobi.
Om du vill exportera en e-bok i PDF-, ePub- eller mobi-format,Kräver Calibre eBook Reader/Manager och kommandoradsverktyg, annars kan ett fel rapporteras "EbookError: Fel under e-boksgenerering: 'ebook-convert'".
Funktioner i GitBook Special Files:
Fil | beskrivning | | book.json | Konfigurationsdata (valfritt) | | README.md | Förord eller introduktion till e-boken (krävs) | | SUMMARY.md | E-bokskatalog (valfritt) | | GLOSSARY.md | Lista över ordförråd/annoteringstermer (valfritt) | Gitbook Allmänna Inställningar
GitBook låter dig anpassa din e-bok med flexibla konfigurationer.
Dessa alternativ specificeras i book.json-filen. För författare som inte är bekanta med JSON-syntax kan du verifiera syntaxen med verktyg som JSONlint.
Variabel | beskrivning | | rot | Vägen till rotmappen som innehåller alla bokfiler, utom book.json | | Struktur | Specificera vägar för readme, abstrakt, ordlistor osv | | Titel | Din boktitel, standardvärdet extraheras från README. På GitBook.com är detta fält förfyllt. | | descrip{filter}tion | Beskrivningen av din bok, standardvärdet extraheras från README. På GitBook.com är detta fält förfyllt. | | Författare | Författarens namn. På GitBook.com är detta fält förfyllt. | | ISBN | ISBN | | Språk | Språktypen i denna bok är ISO-kod. Standardvärdet är en | | Regi | Ordning på textläsning. Det kan vara RTL (höger-till-vänster) eller LTR (vänster-till-höger), och standardvärdet beror på språkets värde. | | Gitbook | GitBook-versionen bör användas. Använd SemVer-specifikationen och acceptera villkor liknande "> = 3.0.0". |
|