From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001
From: Ignat Beresnev <ignat.beresnev@jetbrains.com>
Date: Thu, 19 Jan 2023 04:10:57 +0100
Subject: Revise README documentation for examples and plugins (#2736)

---
 plugins/mathjax/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 plugins/mathjax/README.md

(limited to 'plugins/mathjax/README.md')

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
+```
-- 
cgit