Evaluate the code written in your documents with Pandoc and Lua
Go to file
perro tuerto f5eb91aa1b Renaming 2023-02-17 10:46:39 -08:00
src Init 2023-02-16 17:04:01 -08:00
tests Init 2023-02-16 17:04:01 -08:00
README.md Renaming 2023-02-17 10:46:39 -08:00

README.md

Pandoc Literate Programming

Pandoc is world famous as a "swiss-army" document converted. However, this is because Pandoc is also a document parser. Thanks to this capability, this repo is a Pandoc filter for literate programming: evaluate the code written in your documents with Pandoc and Lua.

Usage

In your terminal, just execute:

sh tests/test.sh FORMAT

Pick one or more FORMAT namespaces, e.g.:

sh tests/test.sh markdown html

You can also use this filter for your documents:1

pandoc --lua-filter literate.lua -t FORMAT YOUR_DOC

Besides your document, you must add the class eval in the fenced code blocks that you want to evaluate. If you also want to replace the code block content with the evaluation result, you also must add the class replace. Check this test if you don't known what I am talking about.

Happy hacking :)


  1. Right now this is only for testing, so only a subset of Lisp function are supported (+, list, first)... The objective is to support any programming language and more! ↩︎