aboutsummaryrefslogtreecommitdiff
path: root/plugins/mathjax
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/mathjax')
-rw-r--r--plugins/mathjax/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md
new file mode 100644
index 00000000..43d07c93
--- /dev/null
+++ b/plugins/mathjax/README.md
@@ -0,0 +1,27 @@
+# MathJax plugin
+
+[MathJax](https://docs.mathjax.org/) allows you to include mathematics in your web pages. The `mathjax` Dokka plugin
+adds the ability to render mathematics found in source code comments.
+
+If MathJax plugin encounters the `@usesMathJax` KDoc tag, it adds `MathJax.js` (ver. 2) with `config=TeX-AMS_SVG`
+to the generated HTML pages.
+
+Usage example:
+
+```kotlin
+/**
+ * Some math \(\sqrt{3x-1}+(1+x)^2\)
+ *
+ * @usesMathJax
+ */
+class Foo {}
+```
+
+Note that the `@usesMathJax` tag is case-sensitive.
+
+The MathJax plugin is published to Maven Central as a
+[separate artifact](https://mvnrepository.com/artifact/org.jetbrains.dokka/mathjax-plugin):
+
+```text
+org.jetbrains.dokka:mathjax-plugin:1.7.20
+```