perro
/
computable-pandoc
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README changes

This commit is contained in:
perro tuerto 2023-03-09 13:52:03 -08:00
parent e87d4b1f43
commit 854687c64a
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -12,19 +12,19 @@ literature"][1].
## Install
Just download this repo:
git clone https://git.cuates.net/perro/literate-pandoc.git
1. Go to [Releases].
2. Download `literate.min.lua`
3. Done!
## Usage
With Pandoc installed and this repo downloaded, do:
With `literate.min.lua` downloaded and Pandoc installed, do:
pandoc --lua-filter PATH/TO/literate-pandoc/src/literate.lua -t FORMAT DOC
pandoc --lua-filter PATH/TO/literate.min.lua -t FORMAT DOC
For example, if `DOC` is `source.md` and the output `FORMAT` is HTML, do:
pandoc --lua-filter PATH/TO/literate-pandoc/src/literate.lua -t html source.md
pandoc --lua-filter PATH/TO/literate.min.lua -t html source.md
## Manual
@ -66,6 +66,7 @@ Happy hacking :)
[literate]: https://en.wikipedia.org/wiki/Literate_programming
[natural]: https://en.wikipedia.org/wiki/Natural-language_programming
[1]: https://web.archive.org/web/20170605163729/http://www.desy.de/user/projects/LitProg/Philosophy.html
[Releases]: https://git.cuates.net/perro/literate-pandoc/releases
[here]: https://git.cuates.net/perro/literate-pandoc/src/branch/no-masters/man/README.md
[Fennel]: https://fennel-lang.org
[Lisp]: https://en.wikipedia.org/wiki/Lisp_(programming_language)