Evaluate the code written in your documents with Pandoc and Lua
Go to file
perro tuerto 879abd7b84 Starting refactoring 2023-03-27 11:48:03 -07:00
dist Starting refactoring 2023-03-27 11:48:03 -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 Finished scripts refactoring 2023-03-23 18:53:36 -07:00
src Starting refactoring 2023-03-27 11:48:03 -07:00
tests Scripts 'make_dist' and 'test' ready 2023-03-22 20:08:06 -07:00
LICENSE.txt Repo ordering 2023-03-08 19:05:42 -08:00
README.md More error analysis; refactoring of lit.puts 2023-03-24 12:08:26 -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:

pandoc lua scripts/test.lua

For other kind of tests, do:

pandoc lua scripts/test.lua -h

For other scripts, do:

pandoc lua scripts/SCRIPT

For example, do:

pandoc lua scripts/make_dist.lua

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