docs for quarto-cli#12326 (#1600)

Author: cscheid

docs/extensions/lua-api.qmd

@@ -256,4 +256,13 @@ Quarto exposes paths to utilities that are likely to be useful to Lua extension
 | Function | Description |
 |------------------------------------|------------------------------------|
 | `quarto.paths.rscript()` | Returns the path to `Rscript` that Quarto uses in the `knitr` engine and R files for `quarto run` scripts |
-| `quarto.paths.tinytex_bin_dir()` | Returns the path to `TinyTeX` binaries directory (where `tlmgr`, `pdlatex` and others are). If Quarto did not install `TinyTeX` and does not found it, it will return `nil`. This means that PDF rendering by Quarto probably used tools found in PATH. |
+| `quarto.paths.tinytex_bin_dir()` | Returns the path to `TinyTeX` binaries directory (where `tlmgr`, `pdlatex` and others are). If Quarto did not install `TinyTeX` and does not found it, it will return `nil`. This means that PDF rendering by Quarto probably used tools found in PATH. |
+
+### Shortcodes
+
+Quarto offers the following helper functions for shortcode developers, to be typically used in shortcode handlers. See the [shortcode development](/docs/extensions/shortcodes.qmd) documentation for more:
+
+| Function | Description |
+|----------|-------------|
+| `quarto.shortcode.read_arg(args, [n])` | Returns the `n`-th argument of the shortcode invocation |
+| `quarto.shortcode.error_output(name, message_or_args, context)` | Creates output to be used by shortcodes to depict an execution error, consistently with how Quarto shows such outputs |

docs/extensions/shortcodes.qmd

@@ -70,7 +70,7 @@ Shortcodes are created using Lua. If you aren't familar with Lua (or with Pandoc
 
 - [Lua Development](lua.qmd) (Lua is the language used to create shortcodes).
 
-- [Lua API Reference](lua-api.qmd), which describes the Lua extension API for Quarto.
+- [Lua API Reference](lua-api.qmd), which describes the Lua extension API for Quarto. Specifically, consider consulting the `quarto.shortcode.*` entry points.
 
 Shortcodes are implemented as Lua functions that take one or more arguments and return a Pandoc AST node (or list of nodes).