GitBook is een op Node.js gebaseerde commandoregeltool die Markdown- en AsciiDoc-syntaxformaten ondersteunt en eBooks kan uitvoeren in HTML, PDF, eBook en andere formaten.
Installeer node.js
Voordat je de gitbook-tool gebruikt, moet de computer node.js omgeving installeren, en na de installatie kun je het versiecommando controleren om te testen of de installatie succesvol is:
Installeer Gitbook
Gitbook wordt geïnstalleerd met npm, de opdrachtregel:
Voer het onderstaande commando uit om de GitBook-versie te zien en te verifiëren dat de installatie succesvol was.
Installeer historische versies
GitBook-CLI maakt het eenvoudig om andere versies van GitBook te downloaden en te installeren om je boeken te testen:
Met gitbook wordt ls-remote de versies opgesomd die gedownload kunnen worden.
Markdown-editor
Hier gebruiken we Markdown-syntaxis als schrijftaal voor onze documenten, we moeten een Markdown-editor voorbereiden, we kunnen veel Markdown-editors op de markt vinden, zoals Typora, MacDown, Bear, MarkdownPad, MarkdownX, de IDE van JetBrains (vereist plugin-installatie), Atom, Jianshu, CSDN en GitBook's eigen GitBook Editor en dergelijke.
Ik heb VS-code-ontwikkelingstools op mijn computer geïnstalleerd, VS-code ondersteunt markdown standaard, ik hoef alleen een preview-plugin artifact te installeren: Markdown Preview Enhanced, en ik ga het gebruiken!
Aanbevolen door vrienden Redacteur typora, adres:De hyperlink-login is zichtbaar.
Initialiseer een boek
GitBook kan een boilerplate opzetten:
Als je een boek wilt aanmaken in een nieuwe map, kun je dat doen door gitbook init ./directory te draaien.
Na uitvoering zie je nog twee bestanden - README.md en SUMMARY.md - die het volgende doen:
README.md - De inleiding van het boek is in dit document geschreven
SUMMARY.md - De catalogusstructuur van het boek is hier geconfigureerd
Ik ben niet bekend met markdown-syntaxis, dus schrijf gewoon een paar zinnen!
Genereer statische webpagina's
Genereer statische webpagina's en draai servers
Al het bovenstaande wordt gegenereerd in de boekcatalogus _book.
Het serve-commando kan ook de poort specificeren:
Geef bij het genereren de versie van gitbook aan, en deze wordt niet eerst lokaal gedownload
Geeft alle lokale gitbook-versies weer op
Geef een lijst van de versies van gitbook die op afstand beschikbaar zijn
Installeer de bijbehorende gitbook-versie
Update naar de nieuwste versie van gitbook
Verwijder de bijbehorende gitbook-versie
Specificeert het niveau van de logstam
Uitvoerfoutmelding
Samenvatting
GitBook gebruikt SUMMARY.md bestanden om de structuur van de hoofdstukken en subhoofdstukken van het boek te definiëren. SUMMARY.md Bestand wordt gebruikt om de inhoudsopgave van het boek te genereren.
Het format van SUMMARY.md is een lijst met links. De titel van de link dient als titel van het hoofdstuk, en de link wordt gericht op het pad naar dat hoofdstukbestand.
Het toevoegen van een geneste lijst aan het hoofdhoofdstuk creëert een kindhoofdstuk.
Eenvoudig voorbeeld:
Daarna gaan we terug naar de commandoregel en voeren we het gitbook init-commando opnieuw uit in de mybook-map. GitBook zoekt naar mappen en bestanden die in SUMMARY.md bestanden worden beschreven,Zo niet, dan wordt het aangemaakt。
Voer PDF-, ePub- of mobi-bestanden uit
Als je een pdf-versie wilt genereren, kun je gitbook pdf draaien, op dezelfde manier, als je epub-formaat exporteert, gitbook epub, als het mobi-formaat is, is gitbook mobi voldoende.
Als je een e-book wilt exporteren in PDF-, ePub- of mobi-formaat,Vereist Calibre eBook Reader/Manager en commandoregeltools, anders kan er een foutmelding worden gemeld: "EbookError: Fout tijdens ebookgeneratie: 'ebook-convert'".
Kenmerken van GitBook Special Files:
Bestand | beschrijving | | book.json | Configuratiegegevens (optioneel) | | README.md | Voorwoord of inleiding van het eBook (vereist) | | SUMMARY.md | E-boekcatalogus (optioneel) | | GLOSSARY.md | Lijst van woordenschat-/annotatietermen (optioneel) |
Gitbook Algemene Instellingen
GitBook stelt je in staat je ebook aan te passen met flexibele configuraties.
Deze opties worden gespecificeerd in het book.json-bestand. Voor auteurs die niet bekend zijn met JSON-syntaxis, kun je de syntaxis verifiëren met tools zoals JSONlint.
variabele | beschrijving | | wortel | Het pad naar de hoofdmap die alle boekbestanden bevat, behalve book.json | | Structuur | Specificeer paden voor readme, abstracts, glossaria, enzovoort | | titel | Je boektitel, de standaardwaarde wordt uit de README gehaald. Op GitBook.com is dit veld vooraf ingebouwd. | | descrip{filter}tion | De beschrijving van je boek, de standaardwaarde wordt gehaald uit de README. Op GitBook.com is dit veld vooraf ingebouwd. | | Auteur | Naam van de auteur. Op GitBook.com is dit veld vooraf ingebouwd. | | ISBN | ISBN | | Taal | Het taaltype van dit boek is ISO-code. De standaardwaarde is en | | Richting | Tekstleesvolgorde. Het kan RTL zijn (rechts-naar-links) of LTR (links-naar-rechts), en de standaardwaarde hangt af van de waarde van de taal. | | gitbook | De GitBook-versie moet worden gebruikt. Gebruik de SemVer-specificatie en accepteer voorwaarden vergelijkbaar met "> = 3.0.0". |
|
Geplaatst op 23-11-2018 14:03:54
|
|
|
|
