forked from Fred/gwift-book
move readme content to install.md; readme.md is used as an book introduction
This commit is contained in:
parent
899dc0b9f0
commit
7cc1560787
|
@ -0,0 +1,23 @@
|
||||||
|
# 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](https://www.gitbook.com/editor/linux).
|
||||||
|
|
||||||
|
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-cli`aura é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`
|
13
README.md
13
README.md
|
@ -1,13 +0,0 @@
|
||||||
# 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](https://www.gitbook.com/editor/linux).
|
|
||||||
|
|
||||||
Pour l'installation, un petit `dpkg -i gitbook-editor.x.y.z.deb`.
|
|
||||||
Seul soucis: un compte Gitbook est requis.
|
|
Loading…
Reference in New Issue