GitBook er et Node.js-baseret kommandolinjeværktøj, der understøtter Markdown- og AsciiDoc-syntaksformater og kan eksportere e-bøger i HTML, PDF, e-bog og andre formater.
Installer node.js
Før du bruger gitbook-værktøjet, skal computeren installere node.js miljø, og efter installationen kan du tjekke versionskommandoen for at teste, om installationen er succesfuld:
Installer Gitbook
Gitbook installeres med npm, kommandolinjen:
Kør kommandoen nedenfor for at se GitBook-versionen og verificere, at installationen var succesfuld.
Installer historiske versioner
gitbook-cli gør det nemt at downloade og installere andre versioner af GitBook for at teste dine bøger:
Ved at bruge gitbook oplister ls-remote de versioner, der kan downloades.
Markdown-editor
Her bruger vi Markdown-syntaks som skrivesprog for vores dokumenter, vi skal forberede en Markdown-editor, vi kan finde mange Markdown-editorer på markedet, såsom Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrains' IDE (kræver plugin-installation), Atom, Jianshu, CSDN og GitBooks egen GitBook Editor og så videre.
Jeg har VS-kodeudviklingsværktøjer installeret på min computer, VS-kode understøtter markdown som standard, jeg skal kun installere et preview-plugin-artefakt: Markdown Preview Enhanced, og jeg vil bruge det!
Anbefalet af venner Redaktør typora, adresse:Hyperlink-login er synlig.
Initialiser en bog
GitBook kan opsætte en standard:
Hvis du ønsker at oprette en bog i en ny mappe, kan du gøre det ved at køre gitbook init ./directory.
Efter udførelsen vil du se to yderligere filer – README.md og SUMMARY.md, som gør følgende:
README.md - Bogens introduktion er skrevet i dette dokument SUMMARY.md - Bogens katalogstruktur er konfigureret her
Jeg er ikke bekendt med markdown-syntaks, så skriv bare et par sætninger!
Generer statiske websider
Generer statiske websider og kør servere
Alt ovenstående vil blive genereret i bogkataloget _book.
Serve-kommandoen kan også specificere porten:
Når du genererer, angiv versionen af gitbook, og den vil ikke blive downloadet lokalt først
Lister alle lokale gitbook-versioner
Lister de versioner af gitbook, der er tilgængelige eksternt
Installer den tilsvarende gitbook-version
Opdatering til den nyeste version af gitbook
Afinstaller den tilsvarende gitbook-version
Angiver niveauet for logarmens
Outputfejlmeddelelse
Resumé
GitBook bruger SUMMARY.md filer til at definere strukturen af bogens kapitler og underkapitler. SUMMARY.md Fil bruges til at generere bogens indholdsfortegnelse.
Formatet for SUMMARY.md er en liste over links. Linkets titel vil fungere som kapitlets titel, og linket vil være rettet mod stien til den kapitelfil.
At tilføje en indlejret liste til forældrekapitlet skaber et underkapitel.
Simpelt eksempel:
Så går vi tilbage til kommandolinjen og kører gitbook init-kommandoen igen i mybook-mappen. GitBook leder efter mapper og filer, der er beskrevet i SUMMARY.md filer,Hvis ikke, bliver den oprettet。
Output PDF-, ePub- eller mobi-filer
Hvis du vil generere en pdf-version, kan du køre gitbook pdf, på samme måde som hvis du eksporterer epub-format, gitbook epub, hvis det er mobi-format, kan gitbook mobi gøre det.
Hvis du vil eksportere en e-bog i PDF-, ePub- eller mobi-format,Kræver Calibre eBook Reader/Manager og kommandolinjeværktøjer, ellers kan der rapporteres en fejl "EbookError: Fejl under e-bogsgenerering: 'ebook-convert'".
Funktioner ved GitBook Special Files:
Fil | beskrivelse | | book.json | Konfigurationsdata (valgfrit) | | README.md | Forord eller introduktion til e-bogen (påkrævet) | | SUMMARY.md | E-bogskatalog (valgfrit) | | GLOSSARY.md | Liste over ordforråd/annotationstermer (valgfrit) | Gitbook Generelle Indstillinger
GitBook giver dig mulighed for at tilpasse din e-bog med fleksible konfigurationer.
Disse muligheder er specificeret i book.json-filen. For forfattere, der ikke er bekendt med JSON-syntaks, kan du verificere syntaksen ved hjælp af værktøjer som JSONlint.
variabel | beskrivelse | | rod | Stien til rodmappen, der indeholder alle bogfilerne, undtagen book.json | | Struktur | Angiv stier for readme, abstracts, glossaries osv | | Titel | Din bogtitel, standardværdien er udtrukket fra README. På GitBook.com er dette felt forudfyldt. | | descrip{filter}tion | Beskrivelsen af din bog, standardværdien er udtrukket fra README. På GitBook.com er dette felt forudfyldt. | | Forfatter | Forfatterens navn. På GitBook.com er dette felt forudfyldt. | | ISBN | ISBN | | Sprog | Sprogtypen i denne bog er ISO-kode. Standardværdien er en | | Instruktion | Tekstlæsningsrækkefølge. Det kan være RTL (højre-til-venstre) eller LTR (venstre-til-højre), og standardværdien afhænger af sprogets værdi. | | gitbook | GitBook-versionen bør bruges. Brug SemVer-specifikationen og accepter betingelser, der ligner "> = 3.0.0". |
|