Go to file
Fred f9a1002502 rewrite a little of step-03 2015-10-14 18:42:37 +02:00
book rewrite a little of step-03 2015-10-14 18:42:37 +02:00
ideas update admin.md 2015-10-14 15:22:00 +02:00
.gitignore rewrite a little of step-03 2015-10-14 18:42:37 +02:00
README.md (re)structure files 2015-10-14 07:59:27 +02:00
package.json change node debian installation + modify node deps 2015-09-14 20:42:57 +02:00
specs.md rewrite a little of step-03 2015-10-14 18:42:37 +02:00

README.md

Installation

Prérequis

sudo aptitude install nodejs. Après cela, lance npm install qui ira récupérer le contenu du fichier package.json.

Editeur

Il existe un éditeur pour Gitbook, qui offre pas mal de fonctionnalités sans avoir à tripatouiller la documentation; il est disponible à l'adresse suivante.

Pour l'installation, un petit dpkg -i gitbook-editor.x.y.z.deb. Seul soucis: un compte Gitbook est requis.

Initialisation

L'initiation du contenu peut se faire une fois que le module gitbook-cliaura été installé, grâce à la commande nodejs node_modules/gitbook-cli/bin/gitbook.js init <folder>. Cette commande se base sur le fichier SUMMARY.md pour générer l'arborescence correcte des fichiers (vides, dans un premier temps).

Compilation

  • nodejs node_modules/gitbook-cli/bin/gitbook.js build
  • nodejs node_modules/gitbook-cli/bin/gitbook.js serve

Formats supportés

Pour les formats autres que HTML (PDF, Mobi & ePub), il faut installer Calibre grâce à un aptitude install Calibre. Attention qu'il y a un bon petit 300MB de dépendances...