computable-pandoc/README.md

👾 Computable Pandoc

Computable Pandoc is a Pandoc filter written in Lua for literate and natural programming (LIN programming), i.e.: "Programming [...] as the process of creating works of literature".

Requirements

• Pandoc

Install

1. Go to Releases.
2. Download the latest version of lin.lua.
3. Done!

Usage

With lin.lua downloaded and Pandoc installed, do:

pandoc -L PATH/TO/lin.lua -t FORMAT DOC

For example, if DOC is source.md and the output FORMAT is HTML, do:

pandoc -L PATH/TO/lin.lua -t html source.md

Manual

Learn how to do LIN programming here.

Develop

Clone this repo:

git clone https://git.cuates.net/perro/computable-pandoc.git

Enter the repo:

cd computable-pandoc

Inside, do the tests:

sh scripts/test.sh

For other kind of tests, do:

sh scripts/test.sh -h

Contribute!

Acknowledgments

This wouldn't be possible without these projects and their collaborators:

• Pandoc: universal document converter and parser; handles the requirements for LIN.
• Lua: programming language; enables LIN.
• Fennel: Lisp dialect with full Lua compatibility; allows native evals for Lisp.

License

Computable Pandoc is under GPLv3.

Happy hacking :)