Generate README from perevirky

Author: tarleb

Makefile

@@ -11,3 +11,7 @@ test-%: $(FILTER_FILE) test/input-%.md test/test-%.yaml
 # Check expected results with perevir
 test:
 	pandoc lua test/runtests.lua test/perevirky/
+
+# Generate README.md from perevirky files.
+README.md: test/docs.yaml $(wildcard test/perevirky/*.md)
+	pandoc -d test/docs --output=README.md

README.md

@@ -1,63 +1,85 @@
 run-lua
-==================================================================
+=======
 
 Executes any Lua command in a `lua` XML processing instruction and
 includes the result in the document.
 
 Example:
 
 ``` markdown
-The fifth triangular number is <?lua return 1 + 2 + 3 + 4 + 5?>.
+The number <?lua return 1 + 2 + 3 + 4 + 5?> is the fifth triangular number.
 ```
 
 This yields
 
-> The fifth triangular number is 15.
+> <div id="output">
+>
+> The number 15 is the fifth triangular number.
+>
+> </div>
 
-The value that's returned by the Lua code is spliced back into the
+The value that’s returned by the Lua code is spliced back into the
 document. The `=` character can be used as a shorthand for
 `return` when placed at the beginning of an expression.
 
 ``` xml
-<?lua =1 + 2 ?>
+1 + 2 = <?lua =1 + 2 ?>
 ```
 
+Result:
+
+> <div id="output">
+>
+> 1 + 2 = 3
+>
+> </div>
+
 The filter tries to detect when the `return` has been omitted and
 inserts it automatically in that case. Therefore, the above can be
 shortened to
 
 ``` xml
-<?lua 1 + 2 ?>
+1 + 2 = <?lua 1 + 2 ?>
 ```
 
+> <div id="output">
+>
+> 1 + 2 = 3
+>
+> </div>
+
 Raw attributes syntax with format `run-lua` or `runlua` can be
 used as an alternative to the processing-instructions-based
 syntax.
 
 For example,
 
-`````markdown
-𝜋 ≈ `math.pi`{=runlua}
-`````
+``` markdown
+𝜋 ≈ `math.pi`{=run-lua}
+
+𝜏 ≈ `2 * math.pi`{=runlua}
+```
 
 yields
 
+> <div id="output">
+>
 > 𝜋 ≈ 3.1415926535898
+>
+> 𝜏 ≈ 6.2831853071796
+>
+> </div>
 
-**Note** that pandoc isn't an XML processor, and the processing
+**Note** that pandoc isn’t an XML processor, and the processing
 instruction is terminated by a single `>`. Use the “raw attribute”
 syntax if your code contains that character:
 
     ```{=runlua}
     return 1 > 0 and 'all is well'
     ```
 
-[CI badge]: https://img.shields.io/github/actions/workflow/status/pandoc-ext/run-lua/ci.yaml?branch=main&logo=github
-[CI workflow]: https://github.com/pandoc-ext/run-lua/actions/workflows/ci.yaml
-
-
 Usage
-------------------------------------------------------------------
+-----
 
 The filter modifies the internal document representation; it can
 be used with many publishing systems that are based on pandoc.
@@ -75,8 +97,8 @@ Users of Quarto can install this filter as an extension with
 
     quarto install extension pandoc-ext/run-lua
 
-and use it by adding `run-lua` to the `filters` entry
-in their YAML header.
+and use it by adding `run-lua` to the `filters` entry in their
+YAML header.
 
 ``` yaml
 ---
@@ -100,7 +122,7 @@ output:
 ```
 
 License
-------------------------------------------------------------------
+-------
 
 This pandoc Lua filter is published under the MIT license, see
 file `LICENSE` for details.

test/docs.yaml

@@ -0,0 +1,11 @@
+input-files:
+  - test/perevirky/01-intro.md
+  - test/perevirky/02-shorthand-equal.md
+  - test/perevirky/03-no-return.md
+  - test/perevirky/04-raw-attributes-inline.md
+  - test/perevirky/10-usage.md
+  - test/perevirky/99-license.md
+
+to: gfm
+markdown-headings: setext
+columns: 66

test/perevirky/02-shorthand-equal.md

@@ -6,14 +6,10 @@ document. The `=` character can be used as a shorthand for
 1 + 2 = <?lua =1 + 2 ?>
 ```
 
-<details>
-
 Result:
 
 > <div id="output">
 >
 > 1 + 2 = 3
 >
 > </div>
-
-</details>

test/perevirky/03-no-return.md

@@ -6,12 +6,8 @@ shortened to
 1 + 2 = <?lua 1 + 2 ?>
 ```
 
-<details>
-
 > <div id="output">
 >
 > 1 + 2 = 3
 >
 > </div>
-
-</details>

test/perevirky/10-usage.md

@@ -0,0 +1,48 @@
+---
+perevir:
+  # No tests in here
+  disable: true
+---
+
+Usage
+------------------------------------------------------------------
+
+The filter modifies the internal document representation; it can
+be used with many publishing systems that are based on pandoc.
+
+### Plain pandoc
+
+Pass the filter to pandoc via the `--lua-filter` (or `-L`) command
+line option.
+
+    pandoc --lua-filter run-lua.lua ...
+
+### Quarto
+
+Users of Quarto can install this filter as an extension with
+
+    quarto install extension pandoc-ext/run-lua
+
+and use it by adding `run-lua` to the `filters` entry
+in their YAML header.
+
+``` yaml
+---
+filters:
+  - run-lua
+---
+```
+
+### R Markdown
+
+Use `pandoc_args` to invoke the filter. See the [R Markdown
+Cookbook](https://bookdown.org/yihui/rmarkdown-cookbook/lua-filters.html)
+for details.
+
+``` yaml
+---
+output:
+  word_document:
+    pandoc_args: ['--lua-filter=run-lua.lua']
+---
+```

test/perevirky/99-license.md

@@ -0,0 +1,11 @@
+---
+perevir:
+  # No tests in here
+  disable: true
+---
+
+License
+------------------------------------------------------------------
+
+This pandoc Lua filter is published under the MIT license, see
+file `LICENSE` for details.