Evaluate the code written in your documents with Pandoc and Lua
Go to file
perro tuerto f95db9f9f3 Renaming 2023-03-16 08:52:04 -07:00
dist Renaming 2023-03-16 08:52:04 -07:00
man Renaming 2023-03-16 08:52:04 -07:00
opt From filter to reader... again 2023-03-09 18:13:01 -08:00
scripts Renaming 2023-03-16 08:52:04 -07:00
src Renaming 2023-03-16 08:52:04 -07:00
tests Ready for parsing functions 2023-03-15 16:33:53 -07:00
LICENSE.txt Repo ordering 2023-03-08 19:05:42 -08:00
README.md Renaming 2023-03-16 08:52:04 -07:00

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

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 :)