[cfinformatica-grup] MarkDown per fitxers publicables/executables

  • From: Joan Josep Ordinas Rosa <jordinas@xxxxxxxxxxxxxxxxxxxxxxxxxxx>
  • To: cfinformatica-grup@xxxxxxxxxxxxx
  • Date: Fri, 19 Feb 2016 11:39:39 +0100

Molts segur que coneixeu la _literate programming_ ideada per Knuth.
Va tenir la seva època quan Knuth va publicar TeX, i ara encara és popular
per exemple amb Haskell.

La idea és simple: en lloc de fer per una banda programes amb comentaris i per
altra documents que citen el codi del programa, amb tots els problemes
de manteniment
que això suposa, fem un sol document que descriu i inclou alhora el programa.

MarkDown és perfecte per això, i la idea no és nova. El que jo he fet és modest
i simple: processar fitxers MarkDown amb `pandoc` per generar HTML, PDF,
ODT, etc. i un simple script del shell per executar el codi que hi ha dins
del fitxer Markdown:

    https://github.com/fadado/literate

Això és perfecte per preparar documents, exercicis, etc.  En aquest
moment està suportat
Shell, Python, Java i C. Ha de ser simple afegir altres llenguatges,
Gràcies a `pandoc` es generen documents amb el codi colorejat, i amb
el script `run-md`
que he fet, que  és simple i gaire be banal, es pot executar el codi
directament extret del
fitxer MarkDown.

Més sobre el concepte:

https://en.wikipedia.org/wiki/Literate_programming
https://en.wikipedia.org/wiki/Donald_Knuth
https://en.wikipedia.org/wiki/WEB
http://www.wiwi.uni-bielefeld.de/lehrbereiche/statoekoinf/comet/mtessmer/Beitraege/nw2md

JJOR

-- 
« Cap home segueix sent massa el que era quan es reconeix a si mateix. »
Thomas Mann

Other related posts: