documentation: documente l'édition, les commandes
- Documente plus en détail comment éditer le projet. - Documente les commandes fournies par le Makefile. Co-Authored-by: iGor milhit <igor@milhit.ch>main v0.2.1
parent
f8ba82b0ea
commit
5bd0a6247d
27
README.md
27
README.md
|
|
@ -21,6 +21,12 @@ retrouver facilement :
|
||||||
Pour éditer, il suffit de modifier le contenu du fichier
|
Pour éditer, il suffit de modifier le contenu du fichier
|
||||||
`./présentation-services.md`.
|
`./présentation-services.md`.
|
||||||
|
|
||||||
|
Dans certains cas, il est nécessaire de modifier :
|
||||||
|
|
||||||
|
- Le modèle HTML (`template.html`) utilisé par `pandoc` pour convertir le
|
||||||
|
markdown en HTML.
|
||||||
|
- Les règles CSS (`style.css`) qui déterminent la forme du PDF final.
|
||||||
|
|
||||||
## Générer
|
## Générer
|
||||||
|
|
||||||
Il faut installer `pandoc` et `pagedjs-cli`, puis lancer la commande suivante :
|
Il faut installer `pandoc` et `pagedjs-cli`, puis lancer la commande suivante :
|
||||||
|
|
@ -31,3 +37,24 @@ pandoc -s --embed-resource \
|
||||||
-V noscript=true --css=style.css --template=template.html \
|
-V noscript=true --css=style.css --template=template.html \
|
||||||
--output=présentation-services.pdf présentation-services.md
|
--output=présentation-services.pdf présentation-services.md
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Commandes
|
||||||
|
|
||||||
|
Il existe un fichier `Makefile` qui facilite à la fois l'édition et la
|
||||||
|
génération du document final.
|
||||||
|
|
||||||
|
Il nécessite les prérequis suivants :
|
||||||
|
|
||||||
|
- `pandoc`.
|
||||||
|
- `pagedjs-cli`.
|
||||||
|
- `watchexec` (pour surveiller les modifications de fichier).
|
||||||
|
- `python` pour lancer un serveur local avec le bon module.
|
||||||
|
|
||||||
|
Les commandes disponibles sont :
|
||||||
|
|
||||||
|
- `make html` pour générer le fichier HTML qui peut être servi par un serveur
|
||||||
|
web pour prévisualiser le résultat, ou modifier le rendu.
|
||||||
|
- `make watch_html` pour regénérer le HTML à chaque fois qu'un fichier source
|
||||||
|
(le markdown, le template HTML, les règles CSS) est modifié (sauvé).
|
||||||
|
- `make serve` pour lancer un serveur web qui se recharge lorsque nécessaire.
|
||||||
|
- `make pdf` pour générer le document final au format PDF.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue