From 2709325ca19bdc68785cbec62e4d705a17fb5204 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Mon, 7 Dec 2020 19:43:20 +0000 Subject: [PATCH] fix block code syntax + explain timesheet --- README.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d525698..ca272fc 100644 --- a/README.md +++ b/README.md @@ -41,22 +41,37 @@ Extrait des timesheets d'un fichier markdown. Usage: -Markdown associé: +En markdown, indiquer: - --- - timesheet: /path/to/file.csv - --- +* une variable `timesheet`, qui indique le nom du fichier vers lequel exporter le contenu des timesheet; +* remplir les timesheet en csv, à l'intérieur du markdown. Pour chaque bloc de code concerné, indiquer une classe `.timesheet` - ```{.timesheet} - 2020-12-15, CL, 1, test - ``` +Exemple: +`````markdown +--- +timesheet: /path/to/file.csv +--- + +```{.timesheet} +2020-12-15, CL, 1, test +``` +````` Execution: ``` -pandoc --to markdown --lua-filter timesheet.lua +pandoc --to markdown --lua-filter timesheet.lua fixtures/timesheet.md +``` + +Le fichier CSV sera enregistré à la place du fichier `/path/to/file.csv` (déterminé par la variable `timesheet` dans le front-matter du document). + +Comme le fichier en sortie n'est pas utilisé, la sortie peut être re-dirigée vers `/dev/null`. Exemple chez JuFa depuis son fichier de TODO + +```bash +#!/bin/bash + +cat $TODO | pandoc --to json -o /dev/null --lua-filter /home/julien/dev/champs-libres/pandocCL/timesheet.lua ``` -Le fichier CSV sera enregistré à la place du fichier `/path/to/file.csv`