GitBook ist ein Node.js-basiertes Kommandozeilen-Tool, das Markdown- und AsciiDoc-Syntaxformate unterstützt und eBooks in HTML, PDF, eBook und anderen Formaten ausgeben kann.
Installieren node.js
Vor der Nutzung des Gitbook-Tools muss der Computer node.js Umgebung installieren, und nach der Installation kannst du den Versionsbefehl prüfen, um zu testen, ob die Installation erfolgreich ist:
Gitbook installieren
Gitbook wird mit npm und Kommandozeile installiert:
Führe den untenstehenden Befehl aus, um die GitBook-Version zu sehen und zu überprüfen, ob die Installation erfolgreich war.
Historische Versionen installieren
GitBook-CLI macht es einfach, andere Versionen von GitBook herunterzuladen und zu installieren, um Ihre Bücher zu testen:
Mit Gitbook listet LS-Remote die Versionen auf, die heruntergeladen werden können.
Markdown-Editor
Hier verwenden wir die Markdown-Syntax als Schreibsprache für unsere Dokumente, wir müssen einen Markdown-Editor vorbereiten, wir finden viele Markdown-Editoren auf dem Markt, wie Typora, MacDown, Bear, MarkdownPad, MarkdownX, die IDE von JetBrains (erfordert eine Plugin-Installation), Atom, Jianshu, CSDN und die eigene von GitBook GitBook Editor und so weiter.
Ich habe VS-Code-Entwicklungstools auf meinem Computer installiert, VS Code unterstützt Markdown standardmäßig, ich muss nur ein Vorschau-Plugin-Artefakt installieren: Markdown Preview Enhanced, und ich werde es verwenden!
Empfohlen von Freunden Editor typora, Adresse:Der Hyperlink-Login ist sichtbar.
Initialisieren Sie ein Buch
GitBook kann ein Standardkonzept aufbauen:
Wenn du ein Buch in ein neues Verzeichnis anlegen möchtest, kannst du das tun, indem du gitbook init ./directory ausführst.
Nach der Ausführung sehen Sie zwei weitere Dateien – README.md und SUMMARY.md –, die Folgendes tun:
README.md - Die Einleitung des Buches ist in diesem Dokument verfasst SUMMARY.md – Die Katalogstruktur des Buches ist hier konfiguriert
Ich kenne mich mit Markdown-Syntax nicht aus, also schreib einfach ein paar Sätze!
Statische Webseiten erstellen
Statische Webseiten erstellen und Server ausführen
Alle oben genannten Beiträge werden im Buchkatalog _book erstellt.
Der Serve-Befehl kann auch den Port angeben:
Beim Erstellen gib die Version von Gitbook an, und es wird nicht zuerst lokal heruntergeladen
Listet alle lokalen Gitbook-Versionen auf
Liste die Versionen von Gitbook auf, die remote verfügbar sind
Installiere die entsprechende Gitbook-Version
Update auf die neueste Version von Gitbook
Deinstalliere die entsprechende Gitbook-Version
Spezifiziert das Level des Logs
Ausgabefehlermeldung
Zusammenfassung
GitBook verwendet SUMMARY.md Dateien, um die Struktur der Kapitel und Unterkapitel des Buches zu definieren. SUMMARY.md Datei wird verwendet, um das Inhaltsverzeichnis des Buches zu erstellen.
Das Format von SUMMARY.md ist eine Liste von Links. Der Titel des Links dient als Titel des Kapitels, und der Link wird auf den Weg zu dieser Kapiteldatei ausgerichtet.
Das Hinzufügen einer verschachtelten Liste zum Elternkapitel erzeugt ein Kinderkapitel.
Einfaches Beispiel:
Dann gehen wir zurück zur Kommandozeile und führen den Gitbook-Befehl init erneut im Mybook-Ordner aus. GitBook sucht nach Verzeichnissen und Dateien, die in SUMMARY.md Dateien beschrieben werden,Wenn nicht, wird es erstellt。
PDF-, ePub- oder Mobi-Dateien ausgeben
Wenn du eine PDF-Version erstellen möchtest, kannst du Gitbook PDF ausführen, genauso, wenn du epub exportierst, gitbook epub, und wenn es mobi ist, reicht gitbook mobi.
Wenn Sie ein E-Book im PDF-, ePub- oder Mobi-Format exportieren möchten,Benötigt Calibre eBook Reader/Manager und Kommandozeilen-Tools, andernfalls kann ein Fehler gemeldet werden: "EbookError: Fehler während der Ebook-Generierung: 'ebook-convert'".
Funktionen von GitBook Special Files:
Akte | Beschreibung | | book.json | Konfigurationsdaten (optional) | | README.md | Vorwort oder Einführung zum eBook (erforderlich) | | SUMMARY.md | E-Buch-Katalog (optional) | | GLOSSARY.md | Liste von Vokabeln/Annotationsbegriffen (optional) | Gitbook Allgemeine Settings
GitBook ermöglicht es dir, dein E-Book mit flexiblen Konfigurationen anzupassen.
Diese Optionen sind in der book.json-Datei angegeben. Für Autoren, die mit der JSON-Syntax nicht vertraut sind, kann man die Syntax mit Tools wie JSONlint überprüfen.
Variable | Beschreibung | | wurzel | Der Pfad zum Root-Ordner, der alle Buchdateien enthält, außer book.json | | Struktur | Spezifiziere Pfade für Readme, Abstracts, Glossare usw | | Titel | Der Buchtitel, der Standardwert wird aus dem README extrahiert. Am GitBook.com ist dieses Feld vorab ausgefüllt. | | descrip{filter}tion | Die Beschreibung deines Buches, der Standardwert wird aus dem README extrahiert. Am GitBook.com ist dieses Feld vorab ausgefüllt. | | Autor | Name des Autors. Am GitBook.com ist dieses Feld vorab ausgefüllt. | | ISBN | ISBN | | Sprache | Der Sprachtyp dieses Buches ist ISO-Code. Der Standardwert ist en | | Regie | Reihenfolge des Textlesens. Es kann RTL (rechts-nach-links) oder LTR (links-rechts) sein, und der Standardwert hängt vom Wert der jeweiligen Sprache ab. | | gitbook | Die GitBook-Version sollte verwendet werden. Verwenden Sie die SemVer-Spezifikation und akzeptieren Sie Bedingungen ähnlich wie "> = 3.0.0". |
|