diff --git a/readme.md b/readme.md index 1368f949148ad732dc2962253baeab2feee80b86..096f8fa87723a239347dc7899dce10f273bd19b2 100644 --- a/readme.md +++ b/readme.md @@ -2,9 +2,9 @@ ## Équipe -- SIBARNI Anas -- ACHOUCH Anas -- YAHIAOUI Mohamed El Amine +- **SIBARNI Anas** +- **ACHOUCH Anas** +- **YAHIAOUI Mohamed El Amine** --- @@ -12,61 +12,49 @@ ### L'outil de conversion utilisé dans notre cas est Pandoc -Pandoc est un outils de conversion en ligne de commande qui récupère un fichier (*par exemple un fichier text simple à balisage léger*) et le compile dans une autre extension. +Pandoc est un outils de conversion en ligne de commande qui récupère un fichie (_par exemple un fichier text simple à balisage léger_) et le compile dans une autre extension. -### Première étape : Installer Pandoc +### Première étape : Installer `Pandoc` Sur l'OS Debian : ```sh -#Installer pandoc et dn support LATEX pour les PDF -sudo apt install pandoc -sudo apt install pandoc-citeproc +sudo apt install pandoc #Installer pandoc +sudo apt install pandoc-citeproc #support LATEX pour les PDF ``` --- -### Convertir un *fichier.md* en PDF +### Convertir le `rapport.md` en fichier `PDF` ```sh #Erreur trop de sous tableau|parti, pas supporter par Latex. A voir alternative. -pandoc <entre>.md -o <sortie>.pdf +#pandoc <entre>.md -o <sortie>.pdf +pandoc rapport.md -o rapport.pdf ``` -### Convertir un *fichier.md* en page HTML +### Convertir le `rapport.md` en page `HTML` -### Install la commande pour le template -Effectuer une copie du template : - -``` bash -# Clones repo to /tmp and copies templates to ~/.pandoc/templates +Effectuer une copie du [`template`](https://github.com/ryangrose/easy-pandoc-templates): +```bash +# Clones le template dans ~/.pandoc/templates curl 'https://raw.githubusercontent.com/ryangrose/easy-pandoc-templates/master/copy_templates.sh' | bash ``` -### Compilation du PDF avec template - -Voici une commande permettant de compiler un ficier html avec un template, et quelques options de personalisation, comme le nom du fichier et le titre. +Conversion en HTML : -[Lien du template open source](https://github.com/ryangrose/easy-pandoc-templates) - -``` bash +```bash # pandoc source.md -o destination.html --template=template_name.html - pandoc rapport.md -f markdown -o rapport.html --template=easy_template.html --toc --metadata title="SAÉ 2.03: Semaine 06 - GRP A7" ``` -### Convertir en HTML avec un tamplate - -```sh -'https://raw.githubusercontent.com/ryangrose/easy-pandoc-templates/master/copy_templates.sh' | bash -``` --- -### Résumé du code à executer +### **Résumé des commandes à executer** ```sh sudo apt install pandoc