GitBook est un outil en ligne de commande basé sur Node.js qui prend en charge les formats syntaxiques Markdown et AsciiDoc, et peut générer des eBooks en HTML, PDF, eBook et autres formats.
Installer node.js
Avant d’utiliser l’outil Gitbook, l’ordinateur doit installer node.js environnement, et après l’installation, vous pouvez vérifier la commande version pour vérifier si l’installation est réussie :
Installer Gitbook
Gitbook est installé avec npm, ligne de commande :
Exécutez la commande ci-dessous pour voir la version GitBook afin de vérifier que l’installation a été réussie.
Installer les versions historiques
gitbook-cli facilite le téléchargement et l’installation d’autres versions de GitBook pour tester vos livres :
L’utilisation de gitbook ls-remote énumère les versions qui peuvent être téléchargées.
Éditeur Markdown
Ici, nous utilisons la syntaxe Markdown comme langage d’écriture pour nos documents, nous devons préparer un éditeur Markdown, nous pouvons trouver de nombreux éditeurs Markdown sur le marché, tels que Typora, MacDown, Bear, MarkdownPad, MarkdownX, l’IDE de JetBrains (nécessite l’installation de plugins), Atom, Jianshu, CSDN et celui de GitBook GitBook Editor, etc.
J’ai des outils de développement de code VS installés sur mon ordinateur, VS Code supporte par défaut markdown, je n’ai qu’à installer un artefact de plugin de preview : Markdown Preview Enhanced, et je vais l’utiliser !
Recommandé par des amis Éditeur typora, adresse :La connexion hyperlientérée est visible.
Initialiser un livre
GitBook peut mettre en place un code standard :
Si vous souhaitez créer un livre dans un nouveau répertoire, vous pouvez le faire en lançant gitbook init ./directory.
Après l’exécution, vous verrez deux autres fichiers - README.md et SUMMARY.md, qui font ce qui suit :
README.md - L’introduction du livre est écrite dans ce document
SUMMARY.md - La structure du catalogue du livre est configurée ici
Je ne connais pas la syntaxe markdown, alors écrivez juste quelques phrases !
Générer des pages web statiques
Générer des pages web statiques et exécuter des serveurs
Tout ce qui précède sera généré dans le catalogue de livres _book.
La commande servir peut également spécifier le port :
Lors de la génération, spécifiez la version de GitBook, et il ne sera pas téléchargé localement en premier
Liste toutes les versions locales de gitbook
Listez les versions de gitbook disponibles à distance
Installez la version Gitbook correspondante
Mise à jour vers la dernière version de gitbook
Désinstaller la version gitbook correspondante
Spécifie le niveau de logarthmique
Message d’erreur de sortie
Résumé
GitBook utilise SUMMARY.md fichiers pour définir la structure des chapitres et sous-chapitres du livre. SUMMARY.md fichier est utilisé pour générer la table des matières du livre.
Le format de SUMMARY.md est une liste de liens. Le titre du lien servira de titre au chapitre, et le lien sera orienté vers le chemin menant à ce fichier de chapitre.
Ajouter une liste imbriquée au chapitre parent crée un chapitre enfant.
Exemple simple :
Ensuite, on retourne à la ligne de commande et on relance la commande gitbook init dans le dossier mybook. GitBook recherche les répertoires et fichiers décrits dans SUMMARY.md fichiers,Sinon, il est créé。
Sortie des fichiers PDF, ePub ou mobi
Si vous voulez générer une version PDF, vous pouvez lancer Gitbook PDF, de la même manière que si vous exportez en format epub, Gitbook epub, si c’est un format mobi, gitbook mobi fera l’affaire.
Si vous souhaitez exporter un e-book au format PDF, ePub ou mobi,Nécessite Calibre Reader/Gestor d’eBook et des outils en ligne de commande, sinon une erreur peut être signalée « EbookError : Erreur lors de la génération d’ebook : 'ebook-convert' ».
Fonctionnalités des fichiers spéciaux GitBook :
fichier | description | | book.json | Données de configuration (optionnelles) | | README.md | Préface ou introduction à l’eBook (obligatoire) | | SUMMARY.md | Catalogue de livres électroniques (optionnel) | | GLOSSARY.md | Liste des termes de vocabulaire/annotation (optionnel) |
Paramètres généraux de Gitbook
GitBook vous permet de personnaliser votre ebook avec des configurations flexibles.
Ces options sont spécifiées dans le fichier book.json. Pour les auteurs qui ne connaissent pas la syntaxe JSON, vous pouvez vérifier la syntaxe en utilisant des outils comme JSONlint.
Variable | description | | racine | Le chemin vers le dossier racine qui contient tous les fichiers livres, sauf book.json | | Structure | Spécifiez les chemins pour le readme, les résumés, les glossaires, etc | | Titre | Le titre de votre livre, la valeur par défaut, est extraite du README. Sur GitBook.com, ce champ est préoccupé. | | descrip{filter}tion | La description de votre livre, la valeur par défaut, est extraite du README. Sur GitBook.com, ce champ est préoccupé. | | Auteur | Nom de l’auteur. Sur GitBook.com, ce champ est préoccupé. | | ISBN | ISBN | | Langue | Le type de langue de ce livre est le code ISO. La valeur par défaut est en | | Direction | Ordre de lecture du texte. Il peut être RTL (droite-à-gauche) ou LTR (gauche-à-droite), et la valeur par défaut dépend de la valeur du langage. | | Gitbook | La version GitBook doit être utilisée. Utilisez la spécification SemVer et acceptez des conditions similaires à « > = 3.0.0 ». |
|
Publié sur 23/11/2018 14:03:54
|
|
|
|
