perro
/
computable-pandoc
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Evaluate the code written in your documents with Pandoc and Lua
19 Commits 1 Branch 1 Tag 455 KiB
Lua 99.8%
Shell 0.2%
Go to file
perro tuerto 270a5ceb22 Ready for parsing functions 2023-03-15 16:33:53 -07:00
dist Ready for parsing functions 2023-03-15 16:33:53 -07:00
man Repo ordering 2023-03-08 19:05:42 -08:00
opt From filter to reader... again 2023-03-09 18:13:01 -08:00
scripts Ready for parsing functions 2023-03-15 16:33:53 -07:00
src Ready for parsing functions 2023-03-15 16:33:53 -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 Finally test.sh again ready 2023-03-15 15:12:48 -07:00

README.md

Literate Pandoc

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

Requirements

Install

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

Usage

With linp.lua downloaded and Pandoc installed, do:

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

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

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

Manual

Learn how to do LiNP here.

Develop

Clone this repo:

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

Enter the repo:

cd literate-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 LiNP.
  • Lua: programming language; enables LiNP.
  • Fennel: Lisp dialect with full Lua compatibility; allows to go from LiNP to Lisp or Lua.

License

Literate Pandoc is under GPLv3.

Happy hacking :)