Commit 0e76a7b1 authored by  JosephK's avatar JosephK
Browse files

Merge branch 'master' into 'master'

Gitbook -> Honkit

See merge request !33
parents fb862f5f 0edf20fb
Pipeline #449242 passed with stage
in 1 minute and 12 seconds
image: framasoft/gitbook:latest
image: node:12-buster
pages:
script:
- npm i
- npx honkit init
- npx honkit build
- sed -i -e 's/<body>/<body><script src="lang.js" type="text\/javascript"><\/script>/g' _book/index.html
- rm -f _book/fr/print/images/*.pdf _book/fr/print/images/*.svg # files too large for the preview
- mv _book/ public/
artifacts:
paths:
- public
expire_in: 1 day
cache:
paths:
- node_modules/
only:
refs:
- master
except:
variables:
- $DEPLOYEMENT_KEY
- $DEPLOYEMENT_USER
- $DEPLOYEMENT_HOST
deploy:
before_script:
- apt-get update
- apt-get --yes --force-yes install rsync
script:
- gitbook init
- gitbook install
- git config user.name "Nobody"
- git config user.email "nobody@framasoft.org"
- gitbook build
- npm i
- npx honkit init
- npx honkit build
- sed -i -e 's/<body>/<body><script src="lang.js" type="text\/javascript"><\/script>/g' _book/index.html
- mkdir _book/traduction-rejoignez-framalang && echo '<html><head><meta http-equiv="refresh" content="0; URL=../fr/framalang/index.html"></head><body></body></html>' > _book/traduction-rejoignez-framalang/index.html
- mv _book/ public/
- mkdir "${HOME}/.ssh"
- chmod 700 "${HOME}/.ssh"
- if [ ! -z ${DEPLOYEMENT_KNOWN_HOSTS+x} ]; then echo -e "${DEPLOYEMENT_KNOWN_HOSTS}" > ${HOME}/.ssh/known_hosts; fi
- eval `ssh-agent -s`
- if [ ! -z ${DEPLOYEMENT_KEY+x} ]; then ssh-add <(echo "$DEPLOYEMENT_KEY" | base64 --decode); fi
- if [ ! -z ${DEPLOYEMENT_KEY+x} ]; then rsync -a --delete public/ ${DEPLOYEMENT_USER}@${DEPLOYEMENT_HOST}:../../web/; fi
- ssh-add <(echo "$DEPLOYEMENT_KEY" | base64 --decode -i);
- rsync -a --rsh='ssh -o "VerifyHostKeyDNS yes"' --delete public/ ${DEPLOYEMENT_USER}@${DEPLOYEMENT_HOST}:../../web/;
only:
refs:
- master
variables:
- $DEPLOYEMENT_KEY
- $DEPLOYEMENT_USER
- $DEPLOYEMENT_HOST
\ No newline at end of file
[![](https://framagit.org/assets/favicon-075eba76312e8421991a0c1f89a89ee81678bcde72319dd3e8047e2a47cd3a42.ico)](https://framagit.org)
![English:](https://upload.wikimedia.org/wikipedia/commons/thumb/a/ae/Flag_of_the_United_Kingdom.svg/20px-Flag_of_the_United_Kingdom.svg.png) **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
🇬🇧 **Framasoft uses GitLab** for the development of its free softwares. Our Github repositories are only mirrors.
If you want to work with us, **fork us on [framagit.org](https://framagit.org)**. (no registration needed, you can sign in with your Github account)
![Français :](https://upload.wikimedia.org/wikipedia/commons/thumb/c/c3/Flag_of_France.svg/20px-Flag_of_France.svg.png) **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs.
🇫🇷 **Framasoft utilise GitLab** pour le développement de ses logiciels libres. Nos dépôts Github ne sont que des miroirs.
Si vous souhaitez travailler avec nous, **forkez-nous sur [framagit.org](https://framagit.org)**. (l'inscription n'est pas nécessaire, vous pouvez vous connecter avec votre compte Github)
* * *
Site de documentation et d'accueil (basée sur Gitbook) des contributeurs aux projets de Framasoft.
Site de documentation et d'accueil (basée sur Honkit) des contributeurs aux projets de Framasoft.
[participer.framasoft.org](https://participer.framasoft.org)
* * *
......@@ -17,7 +17,7 @@ Site de documentation et d'accueil (basée sur Gitbook) des contributeurs aux pr
### Rédaction
Les fichiers sont rédigés avec [la syntaxe markdown](https://docs.framasoft.org/fr/mattermost/help/messaging/formatting-text.html)
mais Gitbook accepte aussi la syntaxe HTML.
mais Honkit accepte aussi la syntaxe HTML.
Par contre, il n'est pas possible de mixer les 2 syntaxes dans un même bloc.
......@@ -51,21 +51,20 @@ Dans `SUMMARY.md`, il n'est pas possible d'afficher une arborescence
de plus de 2 niveaux et les titres ne sont pas pris en compte
(ils ne sont laissés qu'à titre indicatif).
Chaque lien `.md` trouvé dans ce fichier sera pris en compte par Gitbook
Chaque lien `.md` trouvé dans ce fichier sera pris en compte par Honkit
pour créer le fichier `.html` correspondant.
Les fichiers qui ne s'y trouvent pas seront placé dans le dossier
comme de simples fichiers statiques (au même titre que les images)
## Créer une copie locale de la documentation
Pour avoir un aperçu du rendu du site il peut être souhaitable d'installer Gitbook localement.
Pour avoir un aperçu du rendu du site il peut être souhaitable d'installer Honkit localement.
### Installation de Gitbook
### Installation de NodeJS
Installez NodeJS, NPM et le client Gitbook :
Installez NodeJS et NPM :
sudo apt-get install nodejs-legacy npm
sudo npm install gitbook-cli -g
### Générer la documentation
......@@ -73,22 +72,19 @@ Clonez votre fork de la documentation
git clone https://framagit.org/<utilisateur>/framasoft/participer.git
Depuis le dossier `participer` procédez à l'installation des plugins requis
Depuis le dossier `participer` procédez à l'installation de honkit et des plugins requis
(la liste des plugins et leur configuration se trouve dans le fichiers `book.json`)
cd participer
gitbook init
gitbook install
gitbook serve --no-watch
npm i
npx honkit init
npx honkit serve
Si tout s'est bien déroulé (la commande se termine par `Serving book on…`,
la copie du site peut être consultée sur :
http://localhost:4000/
L’option `--no-watch` permet d'éviter que chaque changement dans les
fichiers entraine un redémarrage automatique du serveur nodejs
ce qui peut être lourd à la longue.
Plus il y a de pages, plus le temps de chargement est long.
Il vaut mieux prendre le temps de finir les changements et redémarrer
......@@ -97,6 +93,6 @@ le serveur manuellement quant on a fini.
Si vous disposez d'un serveur web en local, plutôt que de se servir du serveur
nodejs, vous pouvez aussi créer le site manuellement avec la commande
gitbook build
npx honkit build
et copier le dossier `_book` où vous le voulez sur le serveur web.
\ No newline at end of file
......@@ -3,7 +3,7 @@
## Rédaction
Les fichiers sont rédigés avec [la syntaxe markdown](https://docs.framasoft.org/fr/mattermost/help/messaging/formatting-text.html)
mais Gitbook accepte aussi la syntaxe HTML.
mais Honkit accepte aussi la syntaxe HTML.
Par contre, il n'est pas possible de mixer les 2 syntaxes dans un même bloc.
......@@ -101,21 +101,20 @@ Dans `SUMMARY.md`, il n'est pas possible d'afficher une arborescence
de plus de 2 niveaux et les titres ne sont pas pris en compte
(ils ne sont laissés qu'à titre indicatif).
Chaque lien `.md` trouvé dans ce fichier sera pris en compte par Gitbook
Chaque lien `.md` trouvé dans ce fichier sera pris en compte par Honkit
pour créer le fichier `.html` correspondant.
Les fichiers qui ne s'y trouvent pas seront placé dans le dossier
comme de simples fichiers statiques (au même titre que les images)
## Créer une copie locale de la documentation
Pour avoir un aperçu du rendu du site il peut être souhaitable d'installer Gitbook localement.
Pour avoir un aperçu du rendu du site il peut être souhaitable d'installer Honkit localement.
### Installation de Gitbook
### Installation de NodeJS
Installez NodeJS, NPM et le client Gitbook :
Installez NodeJS et NPM :
sudo apt-get install nodejs-legacy npm
sudo npm install gitbook-cli -g
### Générer la documentation
......@@ -123,22 +122,19 @@ Clonez votre fork de la documentation
git clone https://framagit.org/<utilisateur>/framasoft/docs.git
Depuis le dossier `docs` procédez à l'installation des plugins requis
Depuis le dossier `docs` procédez à l'installation de Honkit et des plugins requis
(la liste des plugins et leur configuration se trouve dans le fichiers `book.json`)
cd docs
gitbook init
gitbook install
gitbook serve --no-watch
npm i
npx honkit init
npx honkit serve
Si tout s'est bien déroulé (la commande se termine par `Serving book on…`,
la copie du site peut être consultée sur :
http://localhost:4000/
L’option `--no-watch` permet d'éviter que chaque changement dans les
fichiers entraîne un redémarrage automatique du serveur nodejs
ce qui peut être lourd à la longue.
Plus il y a de pages, plus le temps de chargement est long.
Il vaut mieux prendre le temps de finir les changements et redémarrer
......@@ -147,6 +143,6 @@ le serveur manuellement quant on a fini.
Si vous disposez d'un serveur web en local, plutôt que de se servir du serveur
nodejs, vous pouvez aussi créer le site manuellement avec la commande
gitbook build
npx honkit build
et copier le dossier `_book` où vous le voulez sur le serveur web.
This diff is collapsed.
{
"devDependencies": {
"gitbook-plugin-edit-link": "^2.0.2",
"gitbook-plugin-page-toc": "^1.1.1",
"gitbook-plugin-toggle-chapters": "^0.0.3",
"honkit": "^3.6.22"
}
}
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment