summaryrefslogtreecommitdiff
path: root/macros/generic/lt3luabridge/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/generic/lt3luabridge/README.md')
-rw-r--r--macros/generic/lt3luabridge/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/macros/generic/lt3luabridge/README.md b/macros/generic/lt3luabridge/README.md
new file mode 100644
index 0000000000..5c4a3f50c3
--- /dev/null
+++ b/macros/generic/lt3luabridge/README.md
@@ -0,0 +1,25 @@
+# lt3luabridge
+
+ [![license](https://img.shields.io/github/license/witiko/markdown)](LICENSE)
+ [![ci](https://github.com/witiko/lt3luabridge/actions/workflows/main.yml/badge.svg)][4]
+
+lt3luabridge is an [expl3][1] package for plain TeX, LaTeX, and ConTeXt that
+allows you to execute Lua code in LuaTeX or any other TeX engine that exposes
+the shell:
+
+``` tex
+\documentclass{standalone}
+\usepackage{l3luabridge}
+\begin{document}
+$ 1 + 2 = \luabridgeExecute{ print(1 + 2) } $
+\end{document}
+```
+
+lt3luabridge was previously part of [the Markdown package for TeX][2], where it
+has been battle-tested since 2016. [Since 2022][3], lt3luabridge has been
+available as a separate package.
+
+ [1]: http://mirrors.ctan.org/macros/latex/contrib/l3kernel/expl3.pdf
+ [2]: https://www.ctan.org/pkg/markdown
+ [3]: https://github.com/witiko/markdown/pull/141
+ [4]: https://github.com/Witiko/lt3luabridge/actions