aboutsummaryrefslogtreecommitdiff
path: root/test/latex-math.txt
diff options
context:
space:
mode:
authorToni Uhlig <matzeton@googlemail.com>2021-10-01 14:21:33 +0200
committerToni Uhlig <matzeton@googlemail.com>2021-10-01 14:21:33 +0200
commitd071b4177c1a3897f4682e245046a45f362b6ac5 (patch)
treee8af69a24b2b97758d4e7f12a65a93185b9b5890 /test/latex-math.txt
Squashed 'deps/md4c/' content from commit 7f05330
git-subtree-dir: deps/md4c git-subtree-split: 7f0533068b4319d8cb3d0f33ca9aa66a857734a6
Diffstat (limited to 'test/latex-math.txt')
-rw-r--r--test/latex-math.txt39
1 files changed, 39 insertions, 0 deletions
diff --git a/test/latex-math.txt b/test/latex-math.txt
new file mode 100644
index 0000000..2a5774c
--- /dev/null
+++ b/test/latex-math.txt
@@ -0,0 +1,39 @@
+
+# LaTeX Math
+
+With the flag `MD_FLAG_LATEXMATHSPANS`, MD4C enables extension for recognition
+of LaTeX style math spans.
+
+A math span is is any text wrapped in dollars or double dollars (`$...$` or
+`$$...$$`).
+
+```````````````````````````````` example
+$a+b=c$ Hello, world!
+.
+<p><x-equation>a+b=c</x-equation> Hello, world!</p>
+````````````````````````````````
+
+If the double dollar sign is used, the math span is a display math span.
+
+```````````````````````````````` example
+This is a display equation: $$\int_a^b x dx$$.
+.
+<p>This is a display equation: <x-equation type="display">\int_a^b x dx</x-equation>.</p>
+````````````````````````````````
+
+Math spans may span multiple lines as they are normal spans:
+
+```````````````````````````````` example
+$$
+\int_a^b
+f(x) dx
+$$
+.
+<p><x-equation type="display">\int_a^b f(x) dx </x-equation></p>
+````````````````````````````````
+
+Note though that many (simple) renderers may output the math spans just as a
+verbatim text. (This includes the HTML renderer used by the `md2html` utility.)
+
+Only advanced renderers which implement LaTeX math syntax can be expected to
+provide better results.