diff options
Diffstat (limited to 'plugins/mathjax/README.md')
| -rw-r--r-- | plugins/mathjax/README.md | 27 |
1 files changed, 0 insertions, 27 deletions
diff --git a/plugins/mathjax/README.md b/plugins/mathjax/README.md deleted file mode 100644 index a12095ee..00000000 --- a/plugins/mathjax/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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.9.10 -``` |