GitBook er et Node.js-basert kommandolinjeverktøy som støtter Markdown- og AsciiDoc-syntaksformater, og kan sende ut e-bøker i HTML, PDF, e-bok og andre formater.
Installer node.js
Før du bruker gitbook-verktøyet, må datamaskinen installere node.js miljø, og etter installasjon kan du sjekke versjonskommandoen for å teste om installasjonen er vellykket:
Installer Gitbook
Gitbook installeres med npm, kommandolinjen:
Kjør kommandoen nedenfor for å se GitBook-versjonen og verifisere at installasjonen var vellykket.
Installer historiske versjoner
gitbook-cli gjør det enkelt å laste ned og installere andre versjoner av GitBook for å teste bøkene dine:
Ved å bruke gitbook lister ls-remote opp versjonene som kan lastes ned.
Markdown-editor
Her bruker vi Markdown-syntaks som skrivespråk for dokumentene våre, vi må forberede en Markdown-editor, vi finner mange Markdown-editorer på markedet, som Typora, MacDown, Bear, MarkdownPad, MarkdownX, JetBrains' IDE (krever plugin-installasjon), Atom, Jianshu, CSDN og GitBooks egen GitBook Editor og så videre.
Jeg har VS-kodeutviklingsverktøy installert på datamaskinen min, VS Code støtter markdown som standard, jeg trenger bare å installere en forhåndsvisningsplugin-artefakt: Markdown Preview Enhanced, og jeg vil bruke den!
Anbefalt av venner Redaktør typora, adresse:Innloggingen med hyperkoblingen er synlig.
Initialiser en bok
GitBook kan sette opp en boilerplate:
Hvis du ønsker å lage en bok i en ny mappe, kan du gjøre det ved å kjøre gitbook init ./directory.
Etter kjøring vil du se to filer til – README.md og SUMMARY.md, som gjør følgende:
README.md - Innledningen til boken er skrevet i dette dokumentet SUMMARY.md - Katalogstrukturen til boken er konfigurert her
Jeg er ikke kjent med markdown-syntaks, så bare skriv noen få setninger!
Generer statiske nettsider
Generer statiske nettsider og kjør servere
Alt dette vil bli generert i bokkatalogen _book.
Serveringskommandoen kan også spesifisere porten:
Når du genererer, spesifiser versjonen av gitbook, og den vil ikke bli lastet ned lokalt først
Lister alle lokale gitbook-versjoner
List opp versjonene av gitbook som er tilgjengelige eksternt
Installer den tilsvarende gitbook-versjonen
Oppdater til den nyeste versjonen av gitbook
Avinstaller den tilsvarende gitbook-versjonen
Spesifiserer nivået på logaritmen
Utgangsfeilmelding
Sammendrag
GitBook bruker SUMMARY.md filer for å definere strukturen til bokens kapitler og underkapitler. SUMMARY.md File brukes til å generere innholdsfortegnelsen i boken.
Formatet på SUMMARY.md er en liste over lenker. Tittelen på lenken vil fungere som tittelen på kapittelet, og lenken vil være rettet mot stien til den kapittelfilen.
Å legge til en nestet liste i foreldrekapittelet oppretter et barnekapittel.
Enkelt eksempel:
Så går vi tilbake til kommandolinjen og kjører gitbook init-kommandoen igjen i mybook-mappen. GitBook ser etter kataloger og filer beskrevet i SUMMARY.md filer,Hvis ikke, blir den opprettet。
Eksporter PDF-, ePub- eller mobi-filer
Hvis du vil lage en pdf-versjon, kan du kjøre gitbook pdf, på samme måte, hvis du eksporterer epub-format, gitbook epub, hvis det er mobi-format, fungerer gitbook mobi.
Hvis du vil eksportere en e-bok i PDF-, ePub- eller mobi-format,Krever Calibre eBook Reader/Manager og kommandolinjeverktøy, ellers kan en feil rapporteres "EbookError: Feil under ebook-generering: 'ebook-convert'".
Funksjoner i GitBook Special Files:
Fil | beskrivelse | | book.json | Konfigurasjonsdata (valgfritt) | | README.md | Forord eller introduksjon til e-boken (påkrevd) | | SUMMARY.md | E-bokkatalog (valgfritt) | | GLOSSARY.md | Liste over vokabular-/annotasjonstermer (valgfritt) | Gitbook generelle innstillinger
GitBook lar deg tilpasse eboken din med fleksible konfigurasjoner.
Disse alternativene er spesifisert i book.json-filen. For forfattere som ikke er kjent med JSON-syntaks, kan du verifisere syntaksen med verktøy som JSONlint.
variabel | beskrivelse | | rot | Stien til rotmappen som inneholder alle bokfilene, bortsett fra book.json | | Struktur | Spesifiser stier for readme, sammendrag, ordlister osv | | Tittel | Boktittelen din, standardverdien hentes fra README-en. På GitBook.com er dette feltet forhåndsfylt. | | descrip{filter}tion | Beskrivelsen av boken din, standardverdien er hentet fra README-en. På GitBook.com er dette feltet forhåndsfylt. | | Forfatter | Forfatterens navn. På GitBook.com er dette feltet forhåndsfylt. | | ISBN | ISBN | | Språk | Språktypen i denne boken er ISO-kode. Standardverdien er en | | Regi | Tekstleserekkefølge. Det kan være RTL (høyre-til-venstre) eller LTR (venstre-til-høyre), og standardverdien avhenger av språkets verdi. | | gitbook | GitBook-versjonen bør brukes. Bruk SemVer-spesifikasjonen og aksepter betingelser som ligner på "> = 3.0.0". |
|