diff --git a/README.md b/README.md index 72659f6..b856e5a 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,14 @@ Pick one or more [FORMAT namespaces], e.g.: sh tests/test.sh markdown html -You can also use this filters in your documents:[^1] +You can also use this filter for your documents:[^1] pandoc --lua-filter literate.lua -t FORMAT YOUR_DOC -Besides your document, you must add the class `eval` in your [fenced code -blocks]. If you also want to replace the code block content with the evaluation -result, you also must add the class `replace`. +Besides your document, you must add the class `eval` in the [fenced code +blocks] that you want to evaluate. If you also want to replace the code block +content with the evaluation result, you also must add the class `replace`. +Check [this test] if you don't known what I am talking about. Happy hacking :) @@ -35,3 +36,4 @@ Happy hacking :) [Lua]: https://www.lua.org/ [FORMAT namespaces]: https://pandoc.org/MANUAL.html#option--to [fenced code blocks]: https://pandoc.org/MANUAL.html#fenced-code-blocks + [this test]: https://git.cuates.net/perro/literate-pandoc/src/branch/no-masters/tests/src/t2.md?display=source